选用教材：《Java核心技术卷一》
第四章 对象与类
一、java程序设计中几种注释方式
1、双斜杠注释（//）
2、单斜杠+*号注释（/*......*/）
3、双斜杠+*号注释（/**......*/）
只有第三种注释方式可以生成注释文档
二、生成注释（除包注释以外）文档的两种方式
1、用eclipse工具生成注释文档：
第一步：在程序中有需要的地方写好注释
第二步：点击最顶上菜单的project
第三步：选择General Javdoc...
到doc文件夹中即可找到生成的index.html文件，也就是注释文档。
2、用命令行工具生成注释文档
命令格式为：javadoc -d docDirectory nameOfPackage1 nameOfPackage2...
想生成几个包的注释文档就在后面写几个包的名字。
当然，也可以只生成某一个类文件的注释文档：
第一步：用javac+类名+.java先编译该类
第二步：再用javadoc+类名+.java生成注释文档
3、总结
个人认为，对新手来说，第一种文档生成方式比较友好。它不仅能单独产生一个用于保存的文件夹，还无需为类路径而烦恼。并且第二种方式时常会出现注释不完整的情况。
三、生成包注释的两种方式
1、在eclipse中新建一个package-info.java文件
直接在需要注释的包上右键选择新建一个包，再勾选图中所示的方框。
再按照上面的方法来生成注释文档。
2、提供一个名为package.html的文件，系统会抽取标记<body>....</body>之间的所有文本
略。
原文：https://www.cnblogs.com/yizhinailu/p/12552034.html