Docstring: differenze tra le versioni

Versione delle 14:49, 3 mar 2023

Versione attuale delle 10:25, 30 ago 2024

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>{{Cita web |url=https://clojure.github.com/clojure/clojure.core-api.html#clojure.core/defn |titolo=Definizione di funzione con docstring in Clojure |accesso=1 maggio 2019 |dataarchivio=29 gennaio 2013 |urlarchivio=https://web.archive.org/web/20130129013007/http://clojure.github.com/clojure/clojure.core-api.html#clojure.core/defn |urlmorto=sì }}</ref>

Riga 5:

== 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