Live briefing
Everything about Docstring
String literal that provides documentation per computer programming language syntax
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. Wikipedia →
🧭 Start here: a 6-step reading path
- Read the overview: DocstringA 5-minute orientation
- Pick up a classic book: Introduction to Computing Using PythonThe most-reprinted book on the subject
- Read the landmark paper: Less Is More: DocString Compression in Code GenerationCited 6 times
- Go sideways: Comparison of programming languages (syntax)A closely related topic
- Go sideways: Python syntax and semanticsA closely related topic
📖 Definitions
Noun A string literal specified in source code that is used, like a comment, to document a specific segment of code, but remains available at run-time.
🗂️ The subject at a glance
🏆 Landmark papers (most cited)
📚 Books worth reading
Introduction to Computing Using PythonLjubomir Perkovic · 2011
Python Basics · 2019
Ranked by number of editions on Open Library, a rough measure of how lasting a book is.
🔗 Related topics
- Comparison of programming languages (syntax) This article compares the syntax of many notable programming languages. Programming language expressions can be broadly classified into four syntax structures:…
- Python syntax and semantics The syntax of the Python programming language is the set of rules that defines how a Python program will be written and interpreted (by both the runtime…
- Doctest doctest is a module included in the Python programming language's standard library that allows the easy generation of tests based on output from the standard…
- List of programming languages by type The notable programming languages listed here are grouped by their notable language attribute. As a language can have multiple attributes, the same language…
- Comment (computer programming) In computer programming, a comment is text embedded in source code that a translator (compiler or interpreter) ignores. Generally, a comment is an annotation…
- Comparison of multi-paradigm programming languages Programming languages can be grouped by the number and types of paradigms supported. A concise reference for the programming paradigms listed in this article…
- Cobra (programming language) Free and open-source software portal Cobra is a discontinued general-purpose, object-oriented programming language. Cobra is designed by Charles Esterbrook…
- Eval In some programming languages, eval, short for evaluate, is a function which evaluates a string as though it were an expression in the language, and returns…