Docstring: differenze tra le versioni
Contenuto cancellato Contenuto aggiunto
m tag source deprecati, replaced: <source lang= → <syntaxhighlight lang= (8), </source> → </syntaxhighlight> (8) |
Funzionalità collegamenti suggeriti: 3 collegamenti inseriti. |
||
| (Una versione intermedia di un altro utente non mostrate) | |||
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 [[Metadato|metadati]] durante l'esecuzione.
Tra i linguaggi che supportano le docstring vi sono [[Python]], [[Lisp]], [[Elixir (linguaggio di programmazione)|Elixir]] e [[Clojure]].<ref>
== Esempi ==
=== Elixir ===
Le docstring sono usate in Elixir per la documentazione, e il [[linguaggio di markup]] usato come [[standard de facto]] è il [[markdown]]:
<syntaxhighlight lang="ruby">
defmodule MyModule do
| |||