注释是向 python 代码添加说明文本，不会被执行，但有助于理解代码。注释类型包括文档字符串、内联注释和 todo 注释。注释用途包括提高可读性、记录意图、协作和调试。最佳实践包括简洁、避免冗余、使用一致的风格和及时更新。
Python 中的注释
注释是向代码添加说明的文本，它们不会被解释器执行，但对于理解代码非常有帮助。
如何添加注释：
- 单行注释：使用井号 #，后面跟注释文本。
- 多行注释：使用三对引号 “”” 或 ”’，其中间是多行注释。
注释的类型：
- 文档字符串：通常是模块、类或函数的第一个字符串，描述其用途和用法。
- 内联注释：放在代码内部，解释该行的作用或目的是什么。
- TODO 注释：标记未完成的任务或需要改进的代码。
注释的用途：
- 提高可读性：注释可以解释代码中的复杂或晦涩部分。
- 记录意图：注释可以记录开发人员在编写代码时的意图和假设。
- 协作：注释有助于其他开发人员了解代码如何工作并进行必要的更改。
- 调试：注释可以帮助调试代码，通过提供有关变量值或代码行为的信息。
最佳实践：
- 保持注释简洁易懂。
- 避免冗余，只注释代码中不明显的方面。
- 使用一致的注释风格，例如 Markdown 或 Sphinx。
- 随着代码的变化更新注释，以保持其准确性。
