7.7 Commenting Python code

A Python comment begins with a “#” and continues to the end of the line. This symbol is called a hash sign. Your comments help those who read your code understand why and how you implemented the functionality the way you did. Your documentation helps those who use your code understand the functionality it provides. We discuss commenting Python code in this section. In the next section, we explore how you can best document your source code.

Although I have used comments for this purpose so far, use documentation techniques to describe your functions, methods, and classes. Use these to describe parameters, their types, and their roles. Starting in the next section, I will do this.

Ideally, you should beautifully write your code and carefully choose your names. This way, anyone reading your Python source can instantly understand what it does. At all times, aim for ...