Special comments called documentation strings, or "doc strings" : Documentation « Function « Python Tutorial






  1. Python Tutorial
  2. Function
  3. Documentation
def foo():
      "This is a doc string."
      return True

# doc strings can be accessed at runtime 
# doc strings can be used to automatically generate documentation.








10.8.Documentation
10.8.1.Documenting Functions
10.8.2.Special comments called documentation strings, or "doc strings"
10.8.3.Doc Strings