Docstring: differenze tra le versioni

Versione delle 03:17, 31 ago 2018

Versione delle 03:40, 1 mag 2019

Riga 1:

Nella [[programmazione (informatica)|programmazione]] una '''docstring''' è un [[letterale (informatica)|letterale]] di tipo [[stringa (informatica)|stringa]] inserito nel [[codice sorgente]] che ha la funzione, analogamente ad un [[commento (informatica)|commento]], di documentare una porzione di codice. A differenza dei commenti, in testo semplice o con una formattazione particolare come [[javadoc]] o [[doxygen]], che vengono ignorati dal parser del compilatore o dell'interprete, le docstring vengono conservate e sono disponibili a runtime, semplificando l'ispezione del codice e fornendo aiuto o metadati durante l'esecuzione.

Tra i linguaggi che supportano le docstring vi sono [[Python]], [[Lisp]], [[Elixir (linguaggio di programmazione)|Elixir]] e [[Clojure]].<ref>[httphttps://clojure.github.com/clojure/clojure.core-api.html#clojure.core/defn Definizione di funzione con docstring in Clojure]</ref>

== Esempi ==

Riga 83:

</source>

Epydoc e Sphinx supportano il formato reStructuredText (reST):<ref>{{cita web|url=httphttps://www.sphinx-doc.org/|titolo=Sphinx}}</ref>

<source lang=python>

""" Brief

Riga 96:

</source>

Le convenzioni stilistiche di Google specificano un loro formato, usato nei progetti in Python di Google e piuttosto diffuso anche altrove, che è anche leggibile da Sphinx:<ref>{{cita web|url=httphttps://google-styleguide.googlecode.com/svn/trunk/pyguide.html#Comments|sito=google-styleguide.googlecode.com|titolo=Google Python Style Guide|editore=Google|urlmorto=sì|urlarchivio=https://web.archive.org/web/20150920230332/http://google-styleguide.googlecode.com/svn/trunk/pyguide.html#Comments|dataarchivio=20 settembre 2015}}</ref>

<source lang=python>

""" Brief

Riga 151:

*{{cita web|http://epydoc.sourceforge.net/docstrings.html|Python Docstrings}}

*{{cita web |1=http://www.linuxselfhelp.com/gnu/elisp/html_chapter/elisp_24.html#SEC361 |2=Documentazione in GNU Emacs Lisp |accesso=18 aprile 2015 |urlarchivio=https://web.archive.org/web/20160303174051/http://www.linuxselfhelp.com/gnu/elisp/html_chapter/elisp_24.html#SEC361 |dataarchivio=3 marzo 2016 |urlmorto=sì }}

*[httphttps://www.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks Sezione] sulle docstring nella documentazione di [[doxygen]]

{{portale|informatica}}