编程之注释规范

来源：互联网发布：彩超工作站软件编辑：程序博客网时间：2024/05/01 02:23

为什么要注释：

使得自己的编程思路更加清晰

使得自己更易维护(以后自己回顾时更易理解)

使得别人易于理解

何时注释：

概括性说明；

不易理解或者易理解错的地方；

设计理念解释(即为何将代码设计成这样，比如边界值的考虑)；

文件头部注释

 @Name: ${package_name} ${file_name} ${class_name}${method_name} @Description: ${todo}(用一句话描述该文件做什么) @Author: author@email.com(以邮箱格式较好) @Date: @Version: V1.0   (修改log，最好是用git实现版本控制) @Announcement:注意事项 @Test:测试用例</span>

方法|函数注释时增加以下字段

 @Parameters:         -inputs 输入参数         -outputs 输出         -returns 返回值</span>

注释Tips

注释应尽可能简洁，并表达清晰

注释长度过长时应合理换行并对齐

注释应与所描述内容进行同样的缩进。

代码块的注释应放在代码块的上方，并且与上一个代码块以空行进行隔开

0 0