程序编写规范之注释 |
您所在的位置：网站首页 › 潮汐的拼音和注释怎么写 › 程序编写规范之注释 |
|
语言编写规范之注释
感谢大佬的博客。这篇博客作用是用于记录个人程序风格的文章。和大佬的文章多有雷同，在大佬的规范上加入自己的风格。请各位键盘留情。 1. 注释原则 1.1 项目开发中，尽量保持代码注释规范和统一。 1.2 注释方便了代码的阅读和维护。 1.3 边写代码边注释，修改代码时要相应修改注释，保证注释和代码的一致性。 1.4 注释要简洁明确，不要出现形容词。 1.5 通过注释可以快速知道所写函数的功能，返回值，参数的使用。 1.6 一般情况下，源程序有效注释量必须在20％以上。 注释不宜太多、不宜太少，准确易懂简洁。 2. 注释建议 1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/**内容*/格式，不得使用// xxx 方式。 说明：在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注释；在 IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。 2. 【强制】所有的抽象方法 （ 包括接口中的方法 ） 必须要用 Javadoc 注释、除了返回值、参数、异常说明外， 还必须指出该方法做什么事情，实现什么功能。 说明：对子类的实现要求，或者调用注意事项，请一并说明。 3. 【强制】所有的类都必须添加创建者和创建日期。 4. 【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释，使用/* */注释， 注意与代码对齐。 5. 【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。 6. 【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。 反例：“TCP 连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。 7. 【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。 说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去 了导航的意义。 8. 【参考】谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。 说明：代码被注释掉有两种可能性：1）后续会恢复此段代码逻辑。2）永久不用。前者如果没有备注信 息，难以知晓注释动机。后者建议直接删掉（代码仓库已然保存了历史代码）。 9. 【参考】对于注释的要求：第一、能够准确反映设计思想和代码逻辑 ； 第二、能够描述业务含义，使别的程序员 能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔 很长时间，也能清晰理解当时的思路 ； 注释也是给继任者看的，使其能够快速接替自己的工作。 10.【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥 的注释，代码的逻辑一旦修改，修改注释是相当大的负担。 反例： // put elephant into fridge put(elephant, fridge); 方法名 put，加上两个有意义的变量名 elephant 和 fridge，已经说明了这是在干什么，语义清晰的代码不需要额 外的注释。 10. 【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。 线上故障有时候就是来源于这些标记处的代码。 1） 待办事宜（TODO）:（标记人，标记时间，[预计处理时间]）表示需要实现，但目前还未实现的功能。这实际 上是一个 Javadoc 的标签，目前的 Javadoc 还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因 为它是一个 Javadoc 标签）。 2） 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）在注释中用 FIXME 标记某代码是错误的， 而且不能工作，需要及时纠正的情况 3.个人风格文件头部注释： /************************************************************************* * @File Name: main.c * @Author: song * @Version: 1.0 * @Mail: [email protected] * @Created Time: 2020年03月30日 星期一 22时34分07秒 ************************************************************************/函数部分注释： /****************************************************************************************** * Function name ： 函数名称 * Description : 函数功能、性能等的描述 * Input Parameter ： 输入参数说明，包括每个参数的作用，取值说明及参数间关系，每个参数单独一行进行描述 * @ t_id : 对应的控制编号 * Return ：函数返回值的说明，每个返回值单独一行进行描述 * @ 0 : 0 函数成功执行。 * @ 1 : 1 函数发生错误。 * Others : 其它说明(可以用来书写算法与思路) ******************************************************************************************/结构体、全局变量、宏定义的注释： #define LED 4 /*宏定义的作用*/ int num; /*全局变量的作用*/ /*结构体的功能*/ typedef struct{ int h; /*High risk*/ int l; /*Low risk*/ int m; /*Middle risk*/ int i; /*Information risk*/ }risk; |
今日新闻 |
点击排行 |
|
推荐新闻 |
图片新闻 |
|
专题文章 |
| CopyRight 2018-2019 实验室设备网 版权所有 win10的实时保护怎么永久关闭 |