Alpha冲刺——凡事预则立

Isab3ll

于 2021-11-11 19:22:55 发布

阅读量219

点赞数

文章标签： python

本文链接：https://blog.csdn.net/rem3mber/article/details/121274058

版权

本文档详述了编程中的注释规约和命名风格，强调注释的重要性以及如何清晰地表达方法功能。同时，规定了命名应遵循的规则，如使用UpperCamelCase和lowerCamelCase风格，并避免中英混杂。对于代码更新和注释同步、废弃代码处理以及命名清晰度等方面也提出了明确的要求。

摘要由CSDN通过智能技术生成

一、注释规约（重）

【强制】所有的方法要完成返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。这种描述不应该包括执行过程细节（它是怎么做的）
【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。
【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。
反例：“TCP连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。
【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。
说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如