DocumentationCodeBonnesPratiques » Historique » Version 15
Daniel Dehennin, 14/12/2012 15:00
72 # c’est bien suffisant
1 | 1 | Emmanuel GARETTE | h1. DocumentationCodeBonnesPratiques |
---|---|---|---|
2 | 1 | Emmanuel GARETTE | |
3 | 1 | Emmanuel GARETTE | h2. Généralité |
4 | 1 | Emmanuel GARETTE | |
5 | 1 | Emmanuel GARETTE | * La documentation technique doit être en anglais. |
6 | 5 | Gérald Schwartzmann | * Elle est placée dans les docstrings du code. |
7 | 1 | Emmanuel GARETTE | |
8 | 1 | Emmanuel GARETTE | h2. Description du module |
9 | 1 | Emmanuel GARETTE | |
10 | 12 | Daniel Dehennin | La docstring du module est placée en haut du fichier juste après le "shebang":https://fr.wikipedia.org/wiki/Shebang, la déclaration d’"encodage des caractères":https://fr.wikipedia.org/wiki/Codage_de_caract%C3%A8res et la licence du code. |
11 | 2 | Gwenael Remond | |
12 | 1 | Emmanuel GARETTE | <pre> |
13 | 12 | Daniel Dehennin | #!/usr/bin/python |
14 | 12 | Daniel Dehennin | # -*- coding: utf-8 -*- |
15 | 12 | Daniel Dehennin | # |
16 | 15 | Daniel Dehennin | ######################################################################## |
17 | 13 | Daniel Dehennin | # <nom du projet> - <description sur une ligne> |
18 | 14 | Daniel Dehennin | # Copyright © 2012 Pôle de Compétences EOLE <eole@ac-dijon.fr> |
19 | 14 | Daniel Dehennin | # |
20 | 12 | Daniel Dehennin | # Licence CeCILL en français http://www.cecill.info/licences/Licence_CeCILL_V2-fr.html |
21 | 6 | Gérald Schwartzmann | # License CeCILL in english http://www.cecill.info/licences/Licence_CeCILL_V2-en.html |
22 | 15 | Daniel Dehennin | ######################################################################## |
23 | 2 | Gwenael Remond | </pre> |
24 | 2 | Gwenael Remond | |
25 | 11 | Daniel Dehennin | La docstring doit contenir : |
26 | 1 | Emmanuel GARETTE | * description rapide en une phrase du module ; |
27 | 1 | Emmanuel GARETTE | * description avancée qui explique le rôle du module ; |
28 | 1 | Emmanuel GARETTE | * des exemples simples d'utilisation. |
29 | 1 | Emmanuel GARETTE | |
30 | 1 | Emmanuel GARETTE | Les exemples peuvent être un prompt : |
31 | 1 | Emmanuel GARETTE | |
32 | 1 | Emmanuel GARETTE | <pre> |
33 | 1 | Emmanuel GARETTE | >>> is_locked() |
34 | 1 | Emmanuel GARETTE | True |
35 | 1 | Emmanuel GARETTE | </pre> |
36 | 1 | Emmanuel GARETTE | |
37 | 1 | Emmanuel GARETTE | ou une portion de code : |
38 | 1 | Emmanuel GARETTE | |
39 | 1 | Emmanuel GARETTE | <pre> |
40 | 1 | Emmanuel GARETTE | :: |
41 | 1 | Emmanuel GARETTE | |
42 | 1 | Emmanuel GARETTE | from toto.titi import is_locked |
43 | 1 | Emmanuel GARETTE | |
44 | 1 | Emmanuel GARETTE | toto() |
45 | 1 | Emmanuel GARETTE | is_locked() |
46 | 1 | Emmanuel GARETTE | </pre> |
47 | 1 | Emmanuel GARETTE | |
48 | 1 | Emmanuel GARETTE | h2. Docstring des méthodes |
49 | 1 | Emmanuel GARETTE | |
50 | 3 | Gwenael Remond | Seules les méthodes publiques (qui ne commencent pas par "_") seront mises dans la documentation (mais les méthodes privées sont aussi à documenter). |
51 | 1 | Emmanuel GARETTE | |
52 | 1 | Emmanuel GARETTE | La docstring doit contenir : |
53 | 1 | Emmanuel GARETTE | |
54 | 1 | Emmanuel GARETTE | * description rapide en une phrase de la méthode ; |
55 | 1 | Emmanuel GARETTE | * si nécessaire une description avancée qui explique le rôle du module ; |
56 | 1 | Emmanuel GARETTE | * si nécessaire des exemples simples d'utilisation. |
57 | 1 | Emmanuel GARETTE | * les paramètres de la façon suivante (xxx étant le nom du paramètre et yyyyyy la description) : |
58 | 1 | Emmanuel GARETTE | |
59 | 1 | Emmanuel GARETTE | <pre> |
60 | 1 | Emmanuel GARETTE | :param xxx: yyyyyy |
61 | 1 | Emmanuel GARETTE | </pre> |
62 | 1 | Emmanuel GARETTE | |
63 | 1 | Emmanuel GARETTE | Si nécessaire les valeurs de retour (yyyyyy étant la description) : |
64 | 1 | Emmanuel GARETTE | |
65 | 1 | Emmanuel GARETTE | <pre> |
66 | 1 | Emmanuel GARETTE | :return: yyyyyy |
67 | 1 | Emmanuel GARETTE | </pre> |
68 | 1 | Emmanuel GARETTE | |
69 | 4 | Gwenael Remond | plus d'info sur la syntaxe des docstrings: http://sphinx-doc.org/domains.html#info-field-lists |
70 | 4 | Gwenael Remond | |
71 | 1 | Emmanuel GARETTE | h2. Docstring des classes |
72 | 1 | Emmanuel GARETTE | |
73 | 10 | Gwenael Remond | comme pour la docstring des modules (mais sans la licence) |
74 | 8 | Gwenael Remond | |
75 | 8 | Gwenael Remond | h2. Tips |
76 | 8 | Gwenael Remond | |
77 | 8 | Gwenael Remond | il est possible de faire un lien portant directement sur le redmine de deux manières : |
78 | 8 | Gwenael Remond | |
79 | 8 | Gwenael Remond | <pre> |
80 | 8 | Gwenael Remond | |
81 | 8 | Gwenael Remond | :issue:`410` |
82 | 8 | Gwenael Remond | |
83 | 8 | Gwenael Remond | </pre> |
84 | 8 | Gwenael Remond | |
85 | 8 | Gwenael Remond | est un lien qui porte directement sur la demande 410 |
86 | 8 | Gwenael Remond | |
87 | 8 | Gwenael Remond | et |
88 | 8 | Gwenael Remond | |
89 | 8 | Gwenael Remond | <pre> |
90 | 8 | Gwenael Remond | |
91 | 8 | Gwenael Remond | :eole:`/projects/creole/wiki/Lock24` |
92 | 8 | Gwenael Remond | |
93 | 8 | Gwenael Remond | </pre> |
94 | 8 | Gwenael Remond | |
95 | 8 | Gwenael Remond | qui est simplement un raccourci vers http://dev-eole.ac-dijon.fr/projects/creole/wiki/Lock24 |