Python代码的注释方式,python 注释代码
在编写Python代码时，确保你的代码易于被他人理解是很重要的。给变量和函数起个合适的名字，合理组织代码，是个好办法。
使用注释是增加代码可读性的另一种方便、简单而重要的方法！
我们将介绍一些编写Python注释的基础知识。你将学会如何优雅地写出干净简洁的注释，并且知道什么时候你可能根本不需要写任何注释。
#为什么注释代码如此重要？
注释是任何程序不可或缺的一部分。它们可以以注释块或代码行的形式出现，以帮助阐明和解释复杂的函数。
在深入研究不同类型的注释之前，让我们仔细看看为什么代码注释如此重要。
假设程序员在以下两种情况下不注释代码。
#当阅读自己的代码时
客户A想在最后一分钟部署他们的Web服务，截止日期就要到了，所以您决定先做这件事，然后添加所有“额外”的东西，如文档、适当的注释等。
最后，Web服务在截止日期前及时部署。
然而，在smdpj来添加评论之前，迎接你的是一个新项目，你的老板要求立即开始。当您处理新项目时，您可能会忘记客户a的所有代码注释。
六个月后，客户A需要为相同的服务构建一个补丁，以满足一些新的需求。维护它是你的工作，因为你是第一个建立它的人。打开文本编辑器后.
# "我之前写了什么？"
你花了几个小时分析你的旧代码，但是你完全迷失在混乱中。你很匆忙，没有正确命名变量，甚至没有在适当的控制流中设置函数。最糟糕的是，剧本里没有注释告诉你什么是什么！
开发人员总是忘记他们自己的代码是做什么的，尤其是如果代码是很久以前或者在巨大的压力下编写的。当截止日期临近，在电脑前几个小时造成眼睛充血，这种压力可以用比平时更混乱的代码形式体现出来。
一旦提交了项目，许多开发人员就懒得评论他们的代码了。当你再次使用它时，可能需要几个小时来分析你所写的内容。
一边写代码一边写注释是防止上述情况的好方法。以后请对你好一点！
#当别人阅读你的代码时
假设您是唯一一个从事小型Django项目的开发人员，并且认为您非常了解自己的代码，因此您不会花更多的时间来编写注释或任何其他解释性文档。
也许到了年底，你的“小Django项目”已经变成了“2万行代码”的项目，你的主管正在安排更多的开发人员来帮助维护。
新开发人员很努力很快介入，但是在合作的最初几天，你会意识到他们会遇到一些麻烦。在项目代码中，你使用了一些奇怪的变量名，并用超简洁的语法编写。这导致新员工花费大量时间一行一行地浏览你的代码，试图弄清楚它是如何工作的。
在这种情况下，在代码中使用注释可以帮助其他开发人员理解您的代码。你可以通过从项目开始就注释代码来帮助与其他开发者的合作。
#如何用Python写注释
既然知道了代码注释为什么如此重要，那就让我们来看一些关于注释的基础知识，以便熟悉如何正确使用它。
#Python注释基金会
要用Python写评论，只需在评论内容前加上“#”:
Python将忽略#标记之后到行尾的所有内容，您可以将它们插入代码中的任何地方，甚至是代码行中：
当smdpj运行上面的代码时，您只会看到这个将运行的输出，其他的都将被忽略。
评论应该简短、恰当、切中要点。PEP 8建议代码保持在79个字符或更少，代码行中的注释最多72个字符。如果你的评论接近或超过这个长度，你需要把它变成多行评论。
Python多行注释遗憾的是，Python不能像C、Java、Go语言那样写多行注释：
在上面的例子中，程序会忽略第一行，但是其他行将导致语法错误。
相反，像Java这样的语言可以很容易地将注释扩展到多行：
该程序将自动忽略/和/之间的所有内容。
虽然Python没有这种多行注释功能，但是有两种简单的方法可以在Python中创建多行注释。
第一种方法是在每行之后简单地按Enter，添加一个新的#标记，然后继续注释：
程序将忽略以#标记开始的每一行。
另一种方法是使用多行字符串将注释用一组三个引号括起来：
这类似于Java中的多行注释，三元引号中包含的所有内容都将成为注释。
虽然这看似提供了多行注释功能，但从技术上来说，这并不是注释。它只是一个没有赋给任何变量的字符串，所以程序不会调用或引用它。然而，由于它将在运行时被忽略，并且不会出现在字节码中，所以它可以有效地充当注释。
但是，放置这些多行“注释”时要小心。根据它们在程序中的位置，它们有时可以被转换成docstring，docstring是与函数或方法相关联的文档片段。如果你把这些“注释”放在函数定义之后，你希望被注释的内容将与对象相关联。使用这种多行注释时要小心。如果有疑问，为了安全起见，在后面的每一行加一个#号。
#Python注释快捷键
每次需要添加评论时都要键入#标记，这可能很繁琐。那么，我们能做些什么来加快速度呢？这里有一些提示可以帮助你更快地添加评论。
第一种是使用多个光标，即通过在屏幕上放置多个光标来完成任务。左键单击时，只要按住ctrl或cmd键，您就会看到屏幕上闪烁的线条：
当同一事物需要在多个地方进行注释时，这是最有效的。
如果我们有一个很长的段落需要注释怎么办？或者批量把代码转换成注释，一行一行注释可能要花很多时间！在这种情况下，只需选择需要注释的代码行，并在PC上按Ctrl/或在Mac上按Cmd/
所有选定的代码前面都有一个#标记，程序会忽略该标记。
如果有多行注释，或者您正在阅读的脚本中的注释非常长，那么您的文本编辑器可能会让您选择用左边的小箭头折叠它们：
只需点击箭头隐藏评论。如果长注释分散在多行或docstring中，这种方法最有效，因为这会占用程序的大部分启动时间。
结合这些技术将使您的代码注释快速而简单。
#Python注释最佳实践
知道如何用Python写注释很重要，但确保注释可读和可理解也很重要。
下面的提示可以帮助你写出真正适合你的代码的注释。
#为自己编写代码时
通过正确地注释你的代码，你可以让你的程序员的生活更轻松。即使没有其他人会看到它，你可能会在事后一遍又一遍地阅读它，这足以成为你添加评论的理由。毕竟你是一个开发者，应该让你的代码容易理解。
为自己写注释的一个非常有用的技巧是把它作为代码的大纲。如果你不确定你的程序将如何发展，那么你可以使用注释来跟踪剩余的工作，或者甚至作为一种跟踪高级程序流程的方式。例如，使用注释来概述伪代码中的函数：
这些注释计划出get_top_cies，这意味着你确切地知道你希望你的函数做什么，并且你可以很容易地在以后把它翻译成代码。
使用这样的评论可以帮助你保持头脑清醒。当遍历你的程序时，你会知道你需要做什么来得到一个功能完整的脚本。将注释“转换”成代码后，记得删除任何变得多余的注释，这样你的代码就可以保持清晰整洁。
您还可以在调试过程中使用注释。注释掉旧代码，看看它如何影响您的输出。如果觉得输出符合要求，可以去掉程序中的注释代码，提高代码的可读性。您还可以使用程序版本控制来方便以后对旧代码的检索。
最后，使用注释来定义您自己代码中的棘手部分。如果你放下一个项目，过几个月或几年再回来做，你会花很多时间去熟悉你写的东西。以防你忘记你的代码做了什么，以后帮你一个忙，给它添加注释，这样以后重读它会更容易更快。
#为他人编写代码时
人看短信喜欢跳来跳去，读码也是。当代码出错时，您必须找出到底是哪里出错了，这样您才能逐行阅读代码。
在大多数其他情况下，您将快速浏览变量和函数定义，以获得要点。用简单的注释解释正在发生的事情确实可以帮助开发人员理解在这种情况下应该做什么。
请善待你的同事，用评论来帮助他们浏览你的代码。如果您有一个复杂的方法或函数，其名称不容易理解，您可能需要在def行后添加一个简短的注释来说明问题：
这可以帮助浏览您的代码的其他开发人员理解该函数。
对于任何公共函数，我们都希望尽可能多地包含一个关联的docstring，而不管它有多复杂：
该字符串将成为。__doc__属性，并将与这个特定的方法正式关联。
PEP 257 guide有多行docstring协议。这些文档字符串出现在文件的顶部，包括整个脚本及其功能的高级概述：
像这样的模块级文档字符串将包含任何相关或需要的信息，供开发人员阅读。编写函数时，建议列出所有的类、异常和函数，以及每个类的一行摘要。
Python注释最差实践
正如编写Python注释有好的标准一样，也有几种类型的注释要尽量避免。这里有一些例子。
#避免：W.E.T .的评论
你的评论应该是D.R.Y，是“不要重复自己”的缩写。这意味着您的代码注释应该很少或没有冗余。您不需要对一段足以解释其本身的代码进行注释，如下所示：
我们可以清楚地看到A是返回值，所以不需要在注释中特别声明这一点。这是W.E.T注解，意思是“把所有的东西都写了两遍”，也可以理解为“浪费了大家的时间”。
W.E.T注释可能是一个简单的错误，尤其是如果您在编写代码之前使用注释来规划代码。然而，一旦代码运行良好，一定要返回并删除不必要的注释。
#避免：使用注释来弥补代码
注释有时会反映出您的代码中可能存在深层次的问题。注释是试图隐藏代码本身问题的一种方式，但是注释应该支持你的代码，而不是试图弥补它。如果你的代码写得很糟糕，那么任何注释都不能修复它。
让我们举一个简单的例子：
这段代码非常不规范，在解释每一行代码之前都有一个注释。通过为变量、函数和集合指定合理的名称，可以简化这个脚本，如下所示：
通过使用易于理解的命名方法，我们可以删除所有不必要的注释，减少代码长度！
注释通常比它们支持的代码要短得多。如果你花了太多时间解释你做了什么，那么你需要回去重构，让你的代码更清晰、更简洁。
#避免：粗鲁的评论
这是开发团队在工作时可能出现的问题。当几个人在处理同一个代码时，其他人可能会检查您所写的内容并做出更改。有时候，你可能会遇到敢这样写评论的人：
这种行为极其恶劣。如果你不小心把这个评论留在那里，然后有客户看到了，那就尴尬了。你是专业人士，在笔记上加上低俗的文字会让自己蒙羞。
#结论
学会优雅地使用注释是有价值的。你不仅学会了如何更清晰、更简洁地编写它们，而且毫无疑问，你将对Python有更深的理解。
知道如何用Python进行注释，可以让所有开发者(包括你自己)的编程生活变得更轻松！他们可以帮助其他开发人员快速理解您的代码，并帮助您再次熟悉您的旧代码。
请注意，当使用注释试图解释或弥补编写得很差的代码时，回过头来修改您的代码是一个更好的选择。注释之前编写的代码，无论是自己的代码还是其他开发者的代码，都是练习用Python编写注释的好方法。
推荐阅读：
零基础入门Python最详细的源代码教程
2019 Python爬虫学习路线图完整版
Python为什么能守住AI人工智能的顶级语言？
Python的崛起，TIOBE编程语言排名再创新高！
历史提交的图片或压缩文件
郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。