作为一枚程序猿除了每日辛勤的敲代码，还要不停地提升技术水平，写代码这么枯燥无聊的工作我们是如何日复一日，年复一年的坚守岗位的呢？当然是因为我们短短几行代码就可以解决人类日常所需，各个领域各种需求，包罗万象，也正是因为融于各种业务当中，我们的代码才变得生动起来。那我们每天写那么多代码，那么多的业务逻辑，我们要怎么维护或是接手某一块儿的工作呢？这个时候我们一定意识到了注释的重要性了，接下来我就注释的使用做一些经验分享。
为什么写注释？
- 提高代码可读性；
- 使程序条理清晰；
- 方便后期代码维护；
- 方便程序员间的交流沟通；
- 生成帮助文档。
注释有哪些类型？
- 单行注释
// 注释一行
- 多行注释
/* …… */ 注释若干行
- 文档注释
/**……*/文档注释
javadoc注释标签语法
| 标签 | 作用域 | 说明 |
|---|---|---|
| @author | 类 | 标明开发该类模块的作者 |
| @version | 类 | 标明该类模块的版本 |
| @see | 类，属性，方法 | 参考转向（相关主题） |
| @param | 方法 | 对方法中某参数的说明 |
| @return | 方法 | 对方法返回值的说明 |
| @exception | 方法 | 方法抛出的异常类型 |
| @throws | 方法 | 方法抛出的异常类型说明 |
| @deprecated | 方法 | 说明不建议使用该方法 |
来自阿里的注释规约
注释的应用
主要以IEDA为示例
-
类头注释
-
方法注释
-
javadoc帮助生成注释文档
首先，要编写一个类，在需要的位置添加注释
然后，找到相应的文件夹下运行命令行执行
javadoc -encoding UTF-8 -d Javadoc API -author -version TestJavadoc.java
javadoc为jdk提供的工具jar
-encoding UTF-8避免编码格式出现冲突
-d Javadoc API是指在当前命令文件夹下创建Javadoc API文件夹，并在该文件夹下生成文档
-author 是指作者
-version是版本
版权声明：本文为qq_35606175原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。