Python注释:如何记录你的代码
注释是所有编码项目的一部分，但是编码人员通常讨厌注释代码的过程。注释帮助你记住一个函数的目的。当其他程序员负责维护您的代码时，他们也可以提供帮助。包括Python在内的任何语言都有好的和坏的注释实践。然而，Python有自己的注释语法，你应该知道。不正确的注释语法会导致代码抛出错误，无法编译。知道如何在Python中注释代码不仅仅是知道语法。您必须知道如何以及何时注释代码。
Python评论语法
有两种类型的评论Python。第一个是内联注释系统。内联注释是一行代码后面的注释。下面是Python中内联注释的一个例子:
x = x + 1 #为x添加1并存储在x中
上面是一个简单的注释，实际上您不会像上面那样注释，因为Python语句即使对于新的Python开发人员来说也太明显了。然而，上面的语句是内联注释的一个很好的例子。“x = x + 1”将正确执行，并给x变量加1。#字符之后的任何字符都将被忽略。这意味着您甚至可以在散列标记之后编写代码，而编译器仍然不会尝试运行该语句。
在Udemy.com上学习终极Python课程并学习你需要的一切
下一个类型的注释系统是评论块。有时需要留下几句句子来解释代码执行的方式。内联评论将无法正常工作，因为这些句子将在您的编辑器中占用几行。答案是使用注释块。以下示例是Python中的注释块：
这是一个评论块。
它占用多行，可以使用
在代码中的任何地方。“”
注意三重报价字符。这些字符用于表示注释块。您可以在报价字符中拥有一个或多个句子，但是您通常不会有几百个评论。就像内联的评论一样，编译器完全忽略了这些语句，因此您甚至可以在注释块中有代码，它将被忽略。只要代码或文本位于引号字符内，就不会导致任何错误。
如何正确注释你的代码
注释语法很容易学习和记忆，但困难的部分是理解如何正确注释代码。注释是代码文档的一部分，所以在编写代码时创建注释非常重要。然而，很容易忽略或忘记注释代码。开发人员错误注释代码也很常见。
做评论的第一条规则是了解你的听众。你的听众总是其他程序员。这意味着您不需要解释每一行代码，特别是容易理解的代码。例如，当你声明一个变量时，你不需要解释你正在声明一个变量。编码人员已经知道变量声明语句是用来做什么的，但是您可以描述为什么要声明这个变量。例如，您可以声明一个将在代码编辑器下几行使用的临时变量。编码人员可能不理解为什么要在代码的开头声明一个额外的变量。您可以在临时变量旁边留下注释，解释为什么要声明这个变量，以及它在稍后的代码中用于什么。
下一个规则是为循环结构注释代码。循环可能更难理解，但你有它们背后的逻辑。您可以使用注释块来解释循环及其与其余代码相关的目的。
另一个大评论要求是函数和类方法。函数和类方法通常是在软件中执行关键函数的大型代码块。编码器还需要使用您的类方法和功能与自己的代码一起使用。它可以帮助其他编码器，当您准确地解释功能和如何与软件的其他部分合作。大多数编码编辑器允许用户查看调用函数的位置，所以他们知道他们是否可以编辑该函数。通常，编码器创建过载的方法而不是重写方法，因为更改当前的方法可以在代码中创建错误。
虽然您不需要使用注释重载代码文件，但它可以极大地帮助其他编码人员理解您的代码。您还可以查看UML编码的注释。UML是一种可以添加到代码文件中的注释标准。一些程序会浏览UML编码的注释，解析它们，然后为您创建文档。如果在工作时注释代码，还可以节省时间，因为您不需要在代码完成后返回代码并重新添加注释。
虽然大多数编码人员讨厌文档和评论，但如果您遵守您的评论，您可以保存自己的时间。确保您评论困难的功能和方法，甚至稍后返回并验证。您希望确保您了解功能和方法背后的逻辑，并检测可以帮助确保他们对必须在未来维护软件的编码器进行意义。
