Python 面试题, Python 中怎么注释代码?

Step 1

Q:: Python 中怎么注释代码？

A:: Python 中可以使用井号 (#) 来注释单行代码，所有在井号后面的内容都将被注释掉，不会被执行。对于多行注释，可以使用三引号（''' 或 """)，将注释内容包裹在三引号之间。这种方式通常用于注释较大段的代码或文档字符串（docstring）。

Step 2

Q:: Python 中注释代码的最佳实践是什么？

A:: 在 Python 中，注释应简洁明了，解释代码的作用而不是重复代码的逻辑。尽量在复杂的逻辑前添加注释，帮助其他开发者理解代码。为了保持代码清晰，可以在函数和类的定义前加上文档字符串（docstring），描述其用途、参数和返回值。此外，应避免在明显的代码行添加注释，如简单的变量赋值语句。

Step 3

Q:: 什么是文档字符串（docstring），它与普通注释有何不同？

A:: 文档字符串（docstring）是多行注释的一种特殊形式，通常用于描述模块、类或函数的用途。它被定义在模块、类或函数的开头，用三引号包围。与普通注释不同，文档字符串可以通过 Python 的内置函数 help() 提取，并作为模块、类或函数的元数据，供其他开发者查看。