Outils d'utilisateurs
documentation
Différences
Cette page vous donne les différences entre la révision choisie et la version actuelle de la page.
|
documentation [2017/10/03 16:08] michelme Création |
documentation [2017/10/03 16:16] (Version actuelle) michelme |
||
|---|---|---|---|
| Ligne 57: | Ligne 57: | ||
| ==== Qu'y mettre ? ==== | ==== Qu'y mettre ? ==== | ||
| - | * Les commentaires du code (une absolue obligation, des gens sont allés en prison pour moins que ça), éventuellement dans un format spécifique (Doxygen par exemple). | + | * Les commentaires du code (une absolue obligation, des gens sont allés en prison pour moins que ça), éventuellement dans un format spécifique (Doxygen par exemple), obligatoirement en ANGLAIS. |
| - | * Les explications spécifiques aux classes, méthodes et attributs ainsi que leur relations. | + | * Les explications spécifiques aux classes, méthodes et attributs ainsi que leur relations, obligatoirement en ANGLAIS. |
| Attention ! Toute explication du fonctionnement général du code, d'un module ou d'un algo doit se trouver sur le wiki (avec éventuellement un lien dans le code si besoin). | Attention ! Toute explication du fonctionnement général du code, d'un module ou d'un algo doit se trouver sur le wiki (avec éventuellement un lien dans le code si besoin). | ||
documentation.1507039715.txt.gz · Dernière modification: 2017/10/03 16:08 par michelme
Outils de la Page
Sauf mention contraire, le contenu de ce wiki est placé sous la licence suivante : CC Attribution 3.0 Unported
