如何优雅地使用Python中的代码注释

在编写Python代码时，确保您的代码易于被其他人理解是很重要的。给变量、函数起合适的名字以及合理地组织代码都是很好的方法。

为什么注释代码如此重要

注释是任何程序的一个组成部分，它们可以以注释块的形式或者在代码行中出现，来帮助阐明解释一个复杂的函数。

开发人员总是忘记他们自己的代码所做的事情，尤其是如果代码是在很久以前编写的。

在代码中使用注释可以很好地帮助其他开发人员读懂你的代码，您可以通过从项目一开始就对代码进行注释来帮助与其他开发人员的合作。

如何用Python编写注释

单行注释：#

多行注释：""" """  这貌似提供了多行注释的功能，但从技术上来说，这并不是一个注释，他仅仅是一个没有分配给任何变量的字符串，所以程序不会调用或者引用它。但是，在放置这些多行“注释”时要小心。根据它们在程序中的位置，它们有时可以转换为docstring，这是与函数或方法相关联的文档片段。如果您在函数定义之后将这些“注释”放进去，那么您想要成为注释的内容将与该对象相关联。在使用这种多行注释时要小心，如果有疑问，保险起见在后面的每一行上添加一个#标记即可。

注释快捷键

如果我们有很长一段文字需要注释呢？或者批量将代码转化为注释，一行一行地注释它可能需要很多时间！在这种情况下，只需选择需要作为注释的代码行并在PC上按Ctrl+/，或在Mac上按Cmd+/

注释的最佳实践

为自己编写代码时：如果您不确定您的程序将如何发展，那么您可以使用注释来跟踪剩余的工作。可以在伪代码的函数中描述这个函数的流程。你将准确的知道你想要函数做什么，后面可以很方便的将其翻译成代码。

为他人编写代码时：对于任何公共函数，我们都希望尽量包含一个关联的docstring，不管它是否复杂：

 

此字符串将成为函数的.__doc__属性，并将正式与该特定方法相关联。