⏾ Concept Map

Docstring ○꠹ Entries

↩ 🔵 🔵 🔵

Primary

၊၊||၊|။

Docstring ○꠹｜Definition｜1st｜20251119205401-00-⌔

Docstring - Wikipedia

Docstring

A docstring is a string literal that annotates an associated section of source code. It provides for the same utility as a comment, but unlike a comment is a string literal and is retained as part of the running program. Some development tools display docstring information as part of an interactive help system.

Programming languages that support docstring include Python, Lisp, Elixir, Clojure,1 Gherkin,2 Julia3 and Haskell.4 Tools that leverage docstring text include cobra-doc (Cobra), doctest (Python), Pydoc (Python), Sphinx (Python).

Printed 2026-06-28.

(echo:: @ ᯤ)

Footnotes

  1. “Function definition with docstring in Clojure”. Archived from the original on 2013-01-29. Retrieved 2017-09-20. ↩

  2. “Step Arguments - Doc Strings”. Archived from the original on 2016-01-31. Retrieved 2016-06-22. ↩

  3. “Documentation — Julia Language 0.4.1 documentation”. docs.julialang.org. Archived from the original on 2015-11-17. ↩

  4. “Docstrings”. ↩

Link to original

Secondary

• • •