Skip to content

Section Comments

Vinicius Reif Biavatti edited this page Jul 25, 2022 · 1 revision
  • Use # (number sign) to make section comments lines
  • Use the first and an end line full with # (number sign)
  • Respect the indentation

HINT: Use the Comment Snippets to facilitate the creation of section comments

✅ Do

###############################################################################
# Section Comment
###############################################################################

class Person:

    ###########################################################################
    # Section Comment
    ###########################################################################
    
    def __init__(self):
        ...

❌ Don't`

# -----------------------------------------------------------------------------
# Section Comment
# -----------------------------------------------------------------------------

"""
Section Comment
"""

"""
###############################################################################
Section Comment
###############################################################################
"""

class Person:

###############################################################################
# Section Comment
###############################################################################
    
    def __init__(self):
        ...
Clone this wiki locally