在代码中加入注释是非常好的编程习惯。
在Java中提供了JavaDOC用于生成类、方法的说明文档。可以通过该文档轻松说明类、方法的作用、参数、返回等信息。
JavaDOC的注释规则如下:
(1) 文档注释置于将要注释的类或方法定义之前。
(2) 专有注释定界符/** 开头。
(3) 第一行描述该方法的目的。
(4) 对每个参数进行注释。每行以@param开始,此后是参数名和简要说明。
(5) 最后一行描述该方法的返回值。以@return开始。
(6) 最后以*/结束。
例如:
1
/** */
/**
2
* 这个方法要完成……
3
* @param name 参数意义
4
* @return 最后要返回一个什么什么的
5
*/
6
![](https://i-blog.csdnimg.cn/blog_migrate/1fa987a29c6482f53d401256f96355eb.gif)
![](https://i-blog.csdnimg.cn/blog_migrate/ca75c07623e1b494fee67e8f316fc310.gif)
2
![](https://i-blog.csdnimg.cn/blog_migrate/d18c02628675d0a2c816449d98bda930.gif)
3
![](https://i-blog.csdnimg.cn/blog_migrate/d18c02628675d0a2c816449d98bda930.gif)
4
![](https://i-blog.csdnimg.cn/blog_migrate/d18c02628675d0a2c816449d98bda930.gif)
5
![](https://i-blog.csdnimg.cn/blog_migrate/8f1ba5b45633e9678d1db480c16cae3f.gif)
6
![](https://i-blog.csdnimg.cn/blog_migrate/4f1150b881333f12a311ae9ef34da474.gif)
——摘自BIG JAVA
当然JavaDOC的功能还不止这些。
@后面还有很多参数。等下次再研究研究。