JavaDoc注释与帮助说明文档

java中注释分为单行注释即//,多行注释即/* +注释内容+ /,文档注释即/* + 注释的内容 + */。

添加注释的原则

代码注释是架起程序设计与阅读者之间的通信桥梁，最大限度的提高团队开发合作效率，也是程序代码可维护性的重要环节之一。有以下原则需遵守：
1.注释形式统一
在整个应用程序中使用具有一致的标点和结构的样式来构造注释。
2.注释内容简洁准确
即防止注释的多义性并且不重复啰嗦

注释可以添加的位置
语法上可以添加在程序的任意位置。但是我们应该添加在合适的位置，一般添加在类和方法上对其进行说明。
javadoc标记的含义
@auther 标明开发该类模块的作者,可以多次使用，以指明多个作者
@version 标明该类模块的版本，可多次使用，只有第一次有效
@see 参考转向，也就是相关主题
@param 对方法中某参数的说明，用于方法
@return 对方法返回值的说明，用于方法
@reception 对方法可能抛出的异常进行说明，用于方法
把注释生成文档的方式
eclipse生成文档的方式为：
类文件点右键选择Export------在弹出框选择java下的javadoc--------在位置上选择你要存放的位置并且在目录和类上选择要生成文档的目录名和类名