写Python代码注释中的小建议

百度已收录   阅读次数: 44
2021-02-1922:01:40 发表评论
摘要

学习python的过程中,有关python的注释有两种形式,一个是“#”号,另一个是"""形成的区间,但是即便是这么简单的注释,其中也有值得推敲的地方,以下是一些小建议……

写Python代码注释中的小建议

开篇寄语

学习python的过程中,有关python的注释有两种形式,一个是“#”号,另一个是"""形成的区间,但是即便是这么简单的注释,其中也有值得推敲的地方,以下是一些小建议。

内容详情

什么是注释

简单地说,注释是添加到源代码中的一个条目,以便更深入地理解为什么以这种方式编写代码背后的逻辑。在Python中,每个注释前都需要有' # '或"""符号。这个符号允许Python解释器或编译器忽略依据文本。

为什么需要注释

在大型代码库中工作时,开发人员可能需要在数周或数月后的注释中再次引用该信息,以确保他们了解该代码的原始用途。此信息对于原始想法的形式逻辑方面是必需的,并且是与其他开发人员一起进行广泛项目时的必要条件。

审查和/或后续修改代码部分的开发人员经常严重依赖注释来识别和遵循原始开发人员的思维过程。通过这种方式,后续的开发人员可以添加、编辑或修改注释,以在代码发生变化时调整对进一步更新的理解或推理。

适用性注释

默认的Python库要求每行代码不超过79个字符。这个规定与注释不同,注释是72个字符。如果注释超出了72个字符的文档字符串限制,开发人员应该添加以' # '符号开头的第二行。通常需要多行代码来解释开发人员如何或为什么编写代码。

当添加注释时,它应该写成完整的句子。它还应该简明地表达一个简单的想法,将解释的重点限制在守则中需要澄清的部分。

通常,开发人员应该将注释的第一个单词大写。如果它被用作标识符,最初的术语应该以小写字母开始。

分享至:
  • 我的微信
  • 微信扫一扫加好友
  • weinxin
  • 我的微信公众号
  • 扫描关注公众号
  • weinxin

发表评论

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen: