Stats

75 Contributors: 5 Monday, April 17, 2017
Licensed under: CC-BY-SA
Not affiliated with Stack Overflow
Rip Tutorial: riptutorial@gmail.com
Roadmap: roadmap

Comments and Documentation

Syntax

  • # This is a single line comment
  • print("")  # This is an inline comment
  • """
    This is
    a multi-line comment
    """

Remarks

Developers should follow the PEP257 - Docstring Conventions guidelines. In some cases, style guides (such as Google Style Guide ones) or documentation rendering third-parties (such as Sphinx) may detail additional conventions for docstrings.

Related Examples