（2015-12-08）使用javadoc生成类的注释文档html

java有三种注释格式：

     1：单行短注释：//

     2：块段落注释：/*     */

     3：文档注释：/**    */

使用文档注释的标记主要有@author，@version,@param,@return,@throws。

例如：

/**
 * <p style="font-size:16px;">
 * thinking in java 章节2练习题，主要学到了如何使用javadoc生成开发文档
 * </p>
 * 
 * @author dz
 * @version 1.0.0 */ public class learn1 { public static void main(String[] args) { // TODO Auto-generated method stub systemPrint("1"); } /** * 输出系统环境相关消息 * * @param a 入参1 */ public static void systemPrint(String a){ System.getProperties().list(System.out);; System.out.println(System.getProperty("user.name")); System.out.println(System.getProperty("user.dir")); System.err.println(System.getProperty("java.library.path")); } }

直接使用eclipse-》Project->Generate javadoc导出注释文档

导出后，在项目路径下的doc文件夹下，注释文档都生成在里面，点击index.html，即可查看类和方法的相关注释信息

 

转载于:https://www.cnblogs.com/mengxiangqihang/p/5033514.html