Docstring (original) (raw)
In programming, a docstring is a string literal specified in source code that is used, like a comment, to document a specific segment of code. Unlike conventional source code comments, or even specifically formatted comments like docblocks, docstrings are not stripped from the source tree when it is parsed and are retained throughout the runtime of the program. This allows the programmer to inspect these comments at run time, for instance as an interactive help system, or as metadata. Languages that support docstrings include Python, Lisp, Elixir, Clojure, Gherkin, Julia and Haskell.
| Property | Value |
|---|---|
| dbo:abstract | In programming, a docstring is a string literal specified in source code that is used, like a comment, to document a specific segment of code. Unlike conventional source code comments, or even specifically formatted comments like docblocks, docstrings are not stripped from the source tree when it is parsed and are retained throughout the runtime of the program. This allows the programmer to inspect these comments at run time, for instance as an interactive help system, or as metadata. Languages that support docstrings include Python, Lisp, Elixir, Clojure, Gherkin, Julia and Haskell. (en) Nella programmazione una docstring è un di tipo stringa inserito nel codice sorgente che ha la funzione, analogamente ad un 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 e Clojure. (it) ドキュメンテーション文字列あるいはdocstring（英語: documentation string、ドックストリング）はプログラミングにおいてコメントのようにソースコードの特定の部分を文書化するための文字列リテラルのこと。通常のコメントやdocblockのように解析時に構文木から除外されず、プログラムの実行時まで保持されるため対話的なヘルプやメタデータとして利用できる。 歴史的にはEmacsの前身のTECOに初めて実装された。 docstringをサポートするプログラミング言語にはPython、Lisp、Elixir、Clojure、 、Julia and Haskellがある。 (ja) |
| dbo:wikiPageExternalLink | http://epydoc.sourceforge.net/docstrings.html http://www.stack.nl/~dimitri/doxygen/docblocks.html%23pythonblocks https://web.archive.org/web/20160303174051/http:/www.linuxselfhelp.com/gnu/elisp/html_chapter/elisp_24.html%23SEC361 |
| dbo:wikiPageID | 4225907 (xsd:integer) |
| dbo:wikiPageLength | 5063 (xsd:nonNegativeInteger) |
| dbo:wikiPageRevisionID | 1104443495 (xsd:integer) |
| dbo:wikiPageWikiLink | dbr:Python_(programming_language) dbr:Julia_(programming_language) dbr:Common_Lisp dbr:Pydoc dbr:Clojure dbr:Cobra_(programming_language) dbr:Elixir_(programming_language) dbr:Epydoc dbr:Lisp_(programming_language) dbr:Comment_(computer_programming) dbr:Computer_programming dbr:Gherkin_(language) dbr:Plain_Old_Documentation dbr:String_literal dbc:Python_(programming_language) dbr:Docblock dbr:Doctest dbr:Doxygen dbc:String_(computer_science) dbr:Source_code dbr:Haskell_(programming_language) dbc:Lisp_(programming_language) dbc:Software_documentation dbc:Programming_constructs dbr:SourceForge dbr:Sphinx_(documentation_generator) dbr:Metadata dbr:Literate_programming |
| dbp:wikiPageUsesTemplate | dbt:Mono dbt:Reflist dbt:Short_description |
| dcterms:subject | dbc:Python_(programming_language) dbc:String_(computer_science) dbc:Lisp_(programming_language) dbc:Software_documentation dbc:Programming_constructs |
| rdf:type | yago:Abstraction100002137 yago:Cognition100023271 yago:Concept105835747 yago:Content105809192 yago:Idea105833840 yago:PsychologicalFeature100023100 yago:WikicatProgrammingConstructs |
| rdfs:comment | In programming, a docstring is a string literal specified in source code that is used, like a comment, to document a specific segment of code. Unlike conventional source code comments, or even specifically formatted comments like docblocks, docstrings are not stripped from the source tree when it is parsed and are retained throughout the runtime of the program. This allows the programmer to inspect these comments at run time, for instance as an interactive help system, or as metadata. Languages that support docstrings include Python, Lisp, Elixir, Clojure, Gherkin, Julia and Haskell. (en) Nella programmazione una docstring è un di tipo stringa inserito nel codice sorgente che ha la funzione, analogamente ad un 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 e Clojure. (it) ドキュメンテーション文字列あるいはdocstring（英語: documentation string、ドックストリング）はプログラミングにおいてコメントのようにソースコードの特定の部分を文書化するための文字列リテラルのこと。通常のコメントやdocblockのように解析時に構文木から除外されず、プログラムの実行時まで保持されるため対話的なヘルプやメタデータとして利用できる。 歴史的にはEmacsの前身のTECOに初めて実装された。 docstringをサポートするプログラミング言語にはPython、Lisp、Elixir、Clojure、 、Julia and Haskellがある。 (ja) |
| rdfs:label | Docstring (en) Docstring (it) ドキュメンテーション文字列 (ja) |
| owl:sameAs | freebase:Docstring yago-res:Docstring wikidata:Docstring dbpedia-it:Docstring dbpedia-ja:Docstring dbpedia-sr:Docstring https://global.dbpedia.org/id/4jDqb |
| prov:wasDerivedFrom | wikipedia-en:Docstring?oldid=1104443495&ns=0 |
| foaf:isPrimaryTopicOf | wikipedia-en:Docstring |
| is dbo:wikiPageRedirects of | dbr:Documentation_string |
| is dbo:wikiPageWikiLink of | dbr:Pdoc dbr:Pytest dbr:Python_syntax_and_semantics dbr:Cobra_(programming_language) dbr:Epydoc dbr:Comment_(computer_programming) dbr:Comparison_of_programming_languages_(syntax) dbr:Plain_Old_Documentation dbr:String_literal dbr:Docblock dbr:Doctest dbr:Software_documentation dbr:Documentation_string |
| is foaf:primaryTopic of | wikipedia-en:Docstring |