【代码规范】常见注释规范

文章来源：公众号-智能化IT系统。

1.在有处理逻辑的代码中，源程序有效注释量必须在20％以上。

说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。

 

2.文件注释：文件注释写入文件头部。

说明：以/* 开始

示例：

/ * * 文件名：[文件名] * 作者：〈版权〉 * 描述：〈描述〉 * 修改人：〈修改人〉 * 修改时间：YYYY-MM-DD  * 修改内容：〈修改内容〉   */

 

说明：每次修改后在文件头部写明修改信息。

示例：

/ *