JavaDoc注释与帮助说明文档

最新推荐文章于 2019-06-25 10:50:53 发布

qq123789_

最新推荐文章于 2019-06-25 10:50:53 发布

阅读量162

点赞数

文章标签：总结

本文链接：https://blog.csdn.net/qq123789_/article/details/90114647

版权

我们知道，在java中注释有三种：单行注释用（//注释内容）；多行注释 （ /*注释内容*/）；文档注释 （/**注释的内容*/）。不难发现，第三种注释方式和第二种方式很相似，他的出现就是为了便于javadoc程序自动生成文档。
为什么要添加注释呢？是因为添加注释有利于程序阅读者的理解，能有效提高团队合作效率；也是有利于以后程序设计员的读取与修改维护。
添加注释的原则：
1、注释形式统一：使用具有一致的标点和结构的样式来构造注释；
2、注释内容准确简洁：内容要简单、明了、含义准确，防止注释的多义性，错误的注释有害无益；
3、注释可以添加在文件中的任意位置，但是我们一般把注释添加再类和方法上。