[JAVA] JAVA 文档注释
2018-02-23 21:53
375 查看
Java 程序设计环境
文档注释
javadoc
JDK中包含的javadoc工具可以由源文件生成一个HTML文档。javadoc从以下几个特性中抽取信息
包
公有类与接口
公有的和受保护的构造器及方法
公有的和受保护的域
包注释:
提供一个以package.html命名的HTML文件,body之间的所有文本都会被抽取出来。
提供一个以package-info.java命名的文件,包含在/**和*/界定的javadoc注释,跟随在一个包语句之后,它不应该包含更多代码或注释。
生成文档
mac-abeen:java abeen$ ls alearnJava doc_html javasrc package.html mac-abeen:java abeen$ javadoc -d doc_html/ alearnJava 正在加载程序包alearnJava的源文件... 正在构造 Javadoc 信息... 标准 Doclet 版本 9.0.4 正在构建所有程序包和类的树... 正在生成doc_html/alearnJava/BaseClassDescription.html... 正在生成doc_html/alearnJava/Employee.html... 正在生成doc_html/alearnJava/HelloSwing.html... 正在生成doc_html/alearnJava/Person.html... 正在生成doc_html/alearnJava/Reflect.html... 正在生成doc_html/alearnJava/Test.html... 正在生成doc_html/alearnJava/Welcome.html... 正在生成doc_html/alearnJava/package-frame.html... 正在生成doc_html/alearnJava/package-summary.html... 正在生成doc_html/alearnJava/package-tree.html... 正在生成doc_html/constant-values.html... 正在构建所有程序包和类的索引... 正在生成doc_html/overview-tree.html... 正在生成doc_html/index-all.html... 正在生成doc_html/deprecated-list.html... 正在构建所有类的索引... 正在生成doc_html/allclasses-frame.html... 正在生成doc_html/allclasses-frame.html... 正在生成doc_html/allclasses-noframe.html... 正在生成doc_html/allclasses-noframe.html... 正在生成doc_html/index.html... 正在生成doc_html/help-doc.html... mac-abeen:java abeen$
相关文章推荐
- java文档注释 编写格式
- Java 类注释文档编写方法
- java 注释文档使用
- 从Java源文件中批量榨取注释到设计文档
- Java基础--->02.单行注释、多行注释,文档注释和API文档。
- 《Java 编程思想》003 Java注释和嵌入式文档
- Java 文档注释
- java 如何写文档注释
- Java文档注释,
- javadoc和Java文档注释
- Java - 文档注释
- JAVA 文档注释--JAVADOC文档
- java文档注释
- java文档注释
- Java学习个人备忘录之文档注释
- 初学Java,文档注释(二)
- Thinking in Java——注释和嵌入式文档
- C++转Java自学之路(四)文档注释、静态代码块与对象初始化过程
- Eclipse中java生成注释文档
- 使用Java的文档注释