Skip to content

Multiple Line Comments

Jump to bottom
Vinicius Reif Biavatti edited this page Jul 25, 2022 · 1 revision
  • Avoid to use multiple line comments. Use multiple inline comments if it is possible, or, use docstrings to document modules, classes, functions and methods

✅ Do

# Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi feugiat nisi
# non quam facilisis vehicula. In hac habitasse platea dictumst. Cras
# maximus dolor et nunc consectetur, sed commodo nisi blandit.

❌ Don't`

"""
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi feugiat nisi non quam facilisis vehicula. In hac habitasse platea dictumst. Cras maximus dolor et nunc consectetur, sed commodo nisi blandit.
"""
  1. Home
  2. Structural Naming Conventions
    1. Project Name
    2. Packages
    3. Modules
    4. Main Module
    5. Test Module
  3. Format Conventions
    1. Line Length 79
    2. Blank Lines
    3. Indentation
    4. Inline Expressions
    5. Spaces
    6. Backslash
    7. Strings
    8. End of File EOF
  4. Code Naming Conventions
    1. Variables
    2. Constants
    3. Functions
    4. Function Parameters
    5. Classes
    6. Methods
    7. Magic Methods
    8. Test Methods
    9. Unused Resources
    10. Errors
    11. Error Alias
    12. Reserved Words
    13. Enums
  5. Inheritance
    1. ABC
    2. Abstract Methods
    3. Mixins
    4. Super
  6. Access Modifiers
    1. Module Variables Access
    2. Module Constants Access
    3. Module Functions Access
    4. Module Classes Access
    5. Class Variables Access
    6. Class Constants Access
    7. Class Attributes Access
    8. Class Methods Access
    9. Class Properties Access
  7. Importation
    1. Import Location
    2. Multiple Module Imports
    3. Multiple Module Resource Imports
    4. Import Alias
    5. Order
  8. Functions and Methods
    1. Parameters
    2. Arguments
    3. Function and Method Calls
    4. Static Methods
    5. Class Methods
    6. Instance Methods
    7. Instace Properties
  9. Documentation
    1. Inline Comments
    2. Multiple Line Comments
    3. Section Comments
    4. Docstrings
  10. Resources
    1. Module Template
    2. Class Template
    3. Docstring Template
    4. Comment Snippets
    5. Editorconfig
Clone this wiki locally