初学编程要注重写注释，为你说明代码规范注释有哪些讲究

来自公众号：strongerHuang

如果领导给你一个项目的源码让你阅读，并理解重构代码，但里面一句注释都没有，我想这肯定是之前同事“删库跑路”了。

 

看一份源码什么很重要？除了各种代码规范之外，还有一个比较重要的就是注释。

注释虽然写起来很痛苦, 但对保证代码可读性至关重要，下面的将描述如何注释以及在哪儿注释。

 

注释风格

 

1.总述

一般使用 // 或 /* */，只要统一就好。

 

2.说明

// 或 /* */ 都可以，但 // 更 常用，要在如何注释及注释风格上确保统一。

文件注释

 

1.总述

在每一个文件开头加入版权、作者、时间等描述。

 

文件注释描述了该文件的内容，如果一个文件只声明，或实现，或测试了一个对象，并且这个对象已经在它的声明处进行了详细的注释，那么就没必要再加上文件注释，除此之外的其他文件都需要文件注释。

 

2.说明

法律公告和作者信息：