« Previous Next »

Python Comments

Comments are explanatory notes within your code. They are ignored by the Python interpreter and serve to make your code more understandable for yourself and others.

Types of Comments:

1. Single-Line Comments:

Use the # symbol to add a comment on a single line. Everything after the # is treated as a comment.

# This is a single-line comment print("Hello") # This is also a comment

2. Multi-Line Comments (Docstrings):

While Python doesn't have a specific syntax for multi-line comments like /* ... */ in other languages, triple quotes ''' ''' or """ """ can be used for creating what are commonly called documentation comments/strings. They define the purpose or expectations for a module/function and are especially valuable as they can become embedded documentation and also be extracted for publishing or reference as documentation external to your program, offering extended comments not intended solely to provide a summary of program content itself

'''This is a multi-line comment. It is more typically thought of as a Docstring when utilized like this to define overall parameters, context, or content''' def my_function(): """This is a docstring that should explain what this specific function does"""

Uses of Comments:

  • Explanation: Explain complex logic or algorithm steps.
  • Debugging: Temporarily disable sections of code during testing.
  • Documentation: Document the purpose and usage of functions or modules, so your own work product serves as future documentation of the task you are actively undertaking..

Good Comment Practices:

  • Be Clear and Concise: Comments should improve code readability, not clutter it.
  • Avoid Redundancy: Don't simply restate what your code clearly displays. Avoid overexplaining what code will illustrate well without need for text commentary/annotation.
  • Keep Comments Updated: When you change code, always verify accuracy of documentation/comment strings, so you do not retain out of sync strings after modifications of program core/base functionality have been applied. Change all aspects at the same time.
« Previous Next »