数据库是编程吗
python代码的注释⽅式有⼏种_Python代码注释的⼀些基础知
识
在编写Python代码时，确保您的代码易于被其他⼈理解是很重要的。给变量、函数起合适的名字以及合理地组织代码都是很好的⽅法。
使⽤注释是增加代码可读性的另⼀个⽅便简单且重要的⽅法！
我们将介绍编写Python注释的⼀些基础知识。您将学习如何优雅地编写⼲净、简洁的注释，以及了解何时您可能根本不需要编写任何注释。
ascii码对照表回车为什么注释代码如此重要
注释是任何程序的⼀个组成部分，它们可以以注释块的形式或者在代码⾏中出现，来帮助阐明解释⼀个复杂的函数。
在深⼊研究不同类型的注释之前，让我们仔细看看为什么代码注释如此重要。
假设在以下两种情况中，程序员不对代码进⾏注释。
当阅读你⾃⼰的代码时
客户端A希望在最后⼀刻部署他们的Web服务，截⽌⽇期就快到了，所以你决定先把它整体先做好，所有“额外”的东西如⽂档、适当的注释等等之后再添加。
最终，在最后期限时，及时地部署了Web服务。
二郎神七十二变哪学的但当你还没来及进⾏添加注释时，你就迎来了⽼板要求马上开始的新项⽬，在进⾏新项⽬的同时，你可能会把客户A的代码注释忘得⼀⼲⼆净。
六个⽉后，客户A需要为相同的服务构建⼀个补丁来满⾜⼀些新的需求。维护它是你的⼯作，因为你是第⼀个建造它的⼈。打开⽂本编辑器后……
“我之前到底写了什么？！”
你花了⼏个⼩时分析你的旧代码，但你完全迷失在混乱中。您当时⾮常匆忙，没有正确命名变量，甚⾄没有在适当的控制流中设置函数。最糟糕的是，脚本中没有任何注释来告诉您什么是什么！
开发⼈员总是忘记他们⾃⼰的代码所做的事情，尤其是如果代码是在很久以前编写的，或者是在很⼤的压⼒下编写的。当最后期限快到了，在电脑前⼏个⼩时导致眼睛充⾎时，这种压⼒可以⽤⽐平时更混乱的代码形式反映出来。
⼀旦提交了项⽬，许多开发⼈员就会因太累了，根本⽆法回过头来注释他们的代码。当到了之后重新来⽤它的时候，可能要花上⼏个⼩时来分析⾃⼰所写的东西。
边写代码边写注释是防⽌上述情况发⽣的⼀个很好的⽅法，请善待未来的你！
当别⼈在阅读你的代码时
假设你是从事⼀个⼩型Django项⽬的唯⼀开发⼈员，感觉⾃⼰很好地理解了⾃⼰的代码，所以你不倾向于花费更多的时间来编写注释或任何其他说明⽂档。
可能到年底，你的“⼩Django项⽬”已经变成了⼀个“20000⾏代码”的项⽬，⽽您的主管正在安排更多的开发⼈员来帮助维护它。
新的开发⼈员努⼒⼯作，以迅速投⼊进来，但在合作的头⼏天，你便会意识到他们会遇到⼀些⿇烦。在项⽬代码中，你使⽤了⼀些奇怪的变量名，并使⽤超级简洁的语法编写。这就导致新员⼯会花费⼤量的时间逐⾏遍历您的代码，以试图弄清楚它是如何⼯作的。
在这种情况下，在代码中使⽤注释可以很好地帮助其他开发⼈员读懂你的代码，你可以通过从项⽬⼀开始就对代码进⾏注释来帮助与其他开发⼈员的合作。
如何⽤Python编写注释
现在我们已经知道了为什么代码注释如此重要，那么让我们来看⼀些有关注释的基本知识，以便熟悉如何正确地使⽤它。
Python注释基础
要⽤Python编写注释，只需将“#”放在您的注释内容之前：
Python会忽略在#标记之后到⾏尾的所有内容，您可以在代码中的任何位置插⼊它们，甚⾄可以在代码⾏中使⽤：
当你运⾏上述代码时，你只会看到This will run的输出，其他的都会被忽略。
评论应该简短、贴切、切中要害。PEP 8建议将代码保持在79个字符或更少，代码⾏中的注释最多为72个字符。如果您的注释接近或超过了该长度，则需要将其转变为多⾏注释。
Python多⾏注释
不幸的是，Python⽆法像⽤C、Java和Go语⾔那样编写多⾏注释：
在上述⽰例中，程序将忽略第⼀⾏，但其他⾏将引发语法错误。
相反，像Java这样的语⾔可以很容易地将注释扩展到多⾏：
程序会⾃动忽略/和/之间的所有内容。文山电力什么时候重组成功
虽然Python没有这种多⾏注释功能，但可以在Python中创建多⾏注释，主要有⼀下两种简单的⽅法。
第⼀种⽅法是在每⼀⾏后⾯简单地按下回车键，添加⼀个新的#标记，然后继续注释：
程序将忽略以#标记开头的每⼀⾏。
另⼀种⽅法是使⽤多⾏字符串将注释包装在⼀组三引号中：
这与Java中的多⾏注释类似，在Java中，包含在三元引号中的所有内容都将成为注释。
虽然这貌似提供了多⾏注释功能，但从技术上讲，这并不是⼀个注释。它仅仅是⼀个没有分配给任何变量的字符串，所以程序不会调⽤或引⽤它。不过，由于它在运⾏时会被忽略并且不会出现在字节码中，所以它可以有效地充当注释。
但是，在放置这些多⾏“注释”时要⼩⼼。根据它们在程序中的位置，它们有时可以转换为docstring，这是与函数或⽅法相关联的⽂档⽚段。如果您在函数定义之后将这些“注释”放进去，那么想要成为注释
的内容将与该对象相关联。在使⽤这种多⾏注释时要⼩⼼，如果有疑问，保险起见在后⾯的每⼀⾏上添加⼀个#标记即可。
Python注释快捷键
每次需要添加注释时，都要键⼊#标记可能会很繁琐。那么，我们能做些什么来加快速度呢？这⾥有⼀些技巧可以帮助你更快地添加注释。
第⼀就是使⽤多个游标，就是通过在屏幕上放置多个光标来完成任务。左键单击时，只需按住ctrl或cmd键，就会看到屏幕上闪烁的线条：
当需要在多个地⽅对相同的事情进⾏注释时，这是最有效的。
如果我们有很长⼀段⽂字需要注释呢？或者批量将代码转化为注释，⼀⾏⼀⾏地注释它可能需要很多时间！在这种情况下，只需选择需要作为注释的代码⾏并在PC上按Ctrl+/，或在Mac上按Cmd+/：
所有选中的代码前都将加上⼀个#标记，并被程序忽略。
如果注释⾏数较多，或者正在阅读的脚本中的注释⾮常长，那么您的⽂本编辑器可能会让您选择使⽤左侧的⼩箭头折叠它们：
只需单击箭头以隐藏注释即可。如果长注释分散在多⾏，或占⽤程序⼤部分启动时间的docstring中，这种⽅法效果最好。
将这些技巧结合在⼀起，将使您的代码注释快速、简单。
Python注释最佳实践
知道如何⽤Python编写注释相当重要，但同样重要的是要确保注释具有可读性和易懂性。
以下技巧，可以帮助您编写真正适合您的代码的注释。
为⾃⼰编写代码时
通过正确地注释⾃⼰的代码，可以让⾃⼰的程序员⽣活更轻松。即使没有其他⼈会看到它，但你之后可能会反复看它，这是你为它添加注释的⾜够的理由。毕竟，您是⼀个开发⼈员，应该让您的代码容易理解。
python基础代码练习
为⾃⼰编写注释的⼀个⾮常有⽤的技巧是将其作为代码的⼤纲。如果不确定你的程序将如何发展，那么您可以使⽤注释来跟踪剩余的⼯作，甚⾄可以作为跟踪⾼级程序流的⼀种⽅法。例如，使⽤注释来勾勒伪代码中的函数：
这些注释计划出了get_top_cies，说明你准确地知道了你想要你的函数做什么，后⾯可以很⽅便地将它翻译成代码。
使⽤这样的注释可以帮助你保持头脑清醒。当遍历你的程序时，将知道要获得⼀个功能齐全的脚本，还需要做些什么。在将注释“转换”成代码之后，请记住删除任何已经变得多余的注释，这样您的代码就可以保持清晰和⼲净。
还可以使⽤注释作为调试过程的⼀部分。注释掉旧代码，看看它如何影响您的输出。如果感觉输出符合要求，那么就可以去掉程序中注释掉的代码，以提⾼代码的可读性。您也可以使⽤程序版本控制，⽅便后⾯旧代码的回。
最后，使⽤注释来定义⾃⼰代码的棘⼿部分。如果你放下⼀个项⽬，⼏个⽉或⼏年后再回到它，你将需要花费⼤量的时间来重新熟悉你所写的东西。为以防万⼀你忘记⾃⼰的代码做了什么，帮未来你⼀个忙，为其添加注释，这样以后就更容易更快速的重新读懂它。
为他⼈编写代码时
⼈们喜欢在阅读⽂本信息时跳来跳去，⽽阅读代码也是如此。当代码出了问题您必须弄清楚到底发⽣了什么错误时，您才可能会逐⾏阅读代码。
在⼤多数其他情况下，您将快速浏览变量和函数定义，以获得要点。⽤简单的注释解释正在发⽣的事情，能真正帮助开发⼈员了解在这个位置上做些什么。
请善待你的同事，⽤注释来帮助他们浏览你的代码。如果您有⼀个名称不易理解的复杂⽅法或函数，您可能需要在def⾏后⾯添加⼀个简短的注释，以说明问题：
这可以帮助正在浏览你的代码的其他开发⼈员了解该函数的功能。
对于任何公共函数，我们都希望尽量包含⼀个关联的docstring，不管它是否复杂：
此字符串将成为函数的.doc属性，并将正式与该特定⽅法相关联。
PEP 257指南有多⾏docstring的约定。这些⽂档字符串出现在⽂件的顶部，包括对整个脚本以及它应该做什么的⾼级概述：
像这样的模块级⽂档字符串将包含任何相关或需要知道的信息，供开发⼈员阅读。在编写⼀个函数时，建议列出所有的类、异常和函数，以及每个类的⼀⾏摘要。
Python注释最糟实践
正如编写Python注释有好的标准⼀样，有⼏种类型的注释要尽量避免。下⾯是⼀些例⼦。
避免：W.E.T.注释
你的注释应该是D.R.Y，这是“Don’t Repeat Yourself.”的缩写，意味着你的代码注释应该很少或没有冗余。您不需要对⼀段⾜以解释⾃⾝的代码进⾏注释，如下所⽰：
我们可以清楚地看到，a是返回值，因此没有必要在注释中特别地声明这⼀点。这就是W.E.T.注释，意思是“wrote everything twice”，也可以理解为“wasted everyone’s time”。
W.E.T.注释可能是⼀个简单的错误，特别是如果在编写代码之前使⽤注释来规划代码。但是，⼀旦代码运⾏良好，⼀定要返回来删除不必要的注释。
避免：利⽤注释来弥补代码
念楞严咒多了业障翻起来
注释有时会反映出您的代码可能存在深层次的问题，注释是试图隐藏代码⾃⾝问题的⼀种⽅法，但注释应该⽀持你的代码，⽽不是试图弥补它。如果您的代码编写得很糟糕，那么任何注释都不会修复它。
让我们以这个简单的例⼦为例：
这段代码很不规范，在解释代码的每⼀⾏之前都有⼀个注释。通过为变量、函数和集合指定合理的名称，这个脚本可以变得更简单，如下所⽰：
通过使⽤易于理解的命名⽅式，我们能够删除所有不必要的注释，并减少代码的长度！
注释⼀般要⽐它们⽀持的代码短很多，如果你花了太多时间解释您所做的事情，那么你需要返回并重构，以使你的代码更加清晰和简洁。
避免：粗鲁的注释
这是在开发团队⼯作时可能会出现的问题。当⼏个⼈都在处理相同的代码时，其他⼈可能会检查你所写的内容并进⾏更改。有时，你可能会遇到⼀个敢于写这样的评论的⼈：
这种⾏为是极其不好的，如果不⼩⼼把这条注释留在了那⾥，然后⼀个客户看到了它，这样会很尴尬。你是⼀个专业⼈⼠，在你的注释中加⼊粗俗的话会有辱⾃⼰的⾝份。
结语
学会优雅地使⽤注释是很有价值的，您不仅学习了如何将其编写得更清楚、更简洁，⽽且⽆疑你也会对Python有更深⼊的了解。
知道如何⽤Python注释可以使所有开发⼈员(包括您⾃⼰)的编程⽣活变得更轻松！它们可以帮助其他开发⼈员快速了解您的代码，并帮助您重新熟悉⾃⼰的旧代码。
注意，当使⽤注释尝试解释或弥补编写不良的代码时，返回并修改你的代码是更好的选择。注释以前编写的代码，⽆论是你⾃⼰的代码还是其他开发⼈员的代码，都是练习⽤Python编写注释的好⽅法。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。