wikinotes

Outils pour utilisateurs

Outils du site

Piste : • sozi • pointeurs • teamviewer • termcap_et_terminfo • table_de_hachage • distribution-linux-minimale • uuencode_et_uudecode • preprocesseur • sqlalchemy
dev:python:documentation_du_code

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentesRévision précédente
Prochaine révision		Révision précédente
dev:python:documentation_du_code [2022/12/29 14:40] – yoanndev:python:documentation_du_code [2023/01/03 23:29] (Version actuelle) – yoann
Ligne 13: Ligne 13:
 Comme pour les commentaires, la recommandation de longueur de ligne d'une docstring est de 72 caractères. Comme pour les commentaires, la recommandation de longueur de ligne d'une docstring est de 72 caractères.
  
-  * class docstrings : Description des classes et des méthodes de classe. La docstring doit être placée immédiatemment sous la classe ou la méthode avec une indentation d'un niveau+  * class docstrings : Description des classes et des méthodes de classe. La docstring doit être placée immédiatement sous la classe ou la méthode avec une indentation d'un niveau
   *    * 
  
Ligne 19: Ligne 19:
   * La description brève   * La description brève
   * Un saut de ligne   * Un saut de ligne
-  * Le developpement de la docstring+  * Le développement de la docstring
   * Une ligne vide   * Une ligne vide
  
Ligne 32: Ligne 32:
 </code> </code>
  
-Des formatages particuliers peuvent être utilisés dans la donctring. Cela être interprété par des outils tiers (doctring parsers) comme **reStructuredText**+Des formatages particuliers peuvent être utilisés au sein de la doctring comme **reStructuredText**. Ils sont ensuite exploités par des outils tiers comme **Sphinx** pour générer de la documentation sous différents dormat (html, man etc) ou vérifier le code.
  
  
-Ci-dessous  un exemple de docstring formatée pour reStructuredText+Ci-dessous  un exemple de docstring formatée avec reStructuredText
 <code python> <code python>
 """Gets and prints the spreadsheet's header columns """Gets and prints the spreadsheet's header columns
Ligne 47: Ligne 47:
 :rtype: list :rtype: list
 """ """
- 
 </code> </code>
 +
 +
 ===== Références ===== ===== Références =====
  
Ligne 54: Ligne 55:
   * https://realpython.com/documenting-python-code/   * https://realpython.com/documenting-python-code/
   * https://towardsdatascience.com/documenting-python-code-with-sphinx-554e1d6c4f6d?gi=4be44bfeb728   * https://towardsdatascience.com/documenting-python-code-with-sphinx-554e1d6c4f6d?gi=4be44bfeb728
 +  * https://sphinx-tutorial.readthedocs.io/step-1/
 +  * https://docutils.sourceforge.io/rst.html#user-documentation
 +  * https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
 +  * https://www.devdungeon.com/content/restructuredtext-rst-tutorial-0
 +  * https://www.datacamp.com/tutorial/docstrings-python
 +  * https://gist.github.com/jesugmz/d83b5e9de7ccc16f71c02adf7d2f3f44
  
dev/python/documentation_du_code.1672324851.txt.gz · Dernière modification : 2022/12/29 14:40 de yoann

Outils de la page

Sauf mention contraire, le contenu de ce wiki est placé sous les termes de la licence suivante : GNU Free Documentation License 1.3
GNU Free Documentation License 1.3 Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki