javaDoc生成文档

javadoc生成文档

概念

javadoc就是生成一个我们自己写的帮助文档；

 

写法

　　使用文档注释来写：/***/

　　　　package com.base;
　　　　//写在类上的是类的文档注释
　　　　/**
 　　　　* @author hongjia
 　　　　* @version 1.0
 　　　　* @since 1.8
 　　　　*/
　　　　public class Doc {
    
​
    　　　　String name;
    　　　　//写在方法上的是方法的文档注释
    　　　　/**
    　　　　 *
     　　　　* @author hongjia
    　　　　 * @param name
     　　　　* @return
     　　　　* @throws Exception
     　　　　*/
   　　　　 public String test(String name) throws Exception{
        　　　　return name;
    　　　　}
　　　　}

 

参数信息

@author：作者 ​ @version：版本号 ​ @since：指明需要最早使用的jdk版本 ​ @param：参数名 ​ @return：返回值情况 ​ @throws：异常抛出情况

 

生成帮助文档

　　　　一、使用命令提示符：
　　　　　　1.进入命令提示符，使用“cd 文档的文件夹”进入编好的文档的文件夹里面；
　　　　　　2.输入”javadoc 可选参数 帮助文档的java文件“，如有中文，可选参数输入“ -encoding UTF-8 -charset UTF-8”；
　　　　　　3.最后输入回车即可；

　　　　二、使用idea： 1.打开Tools工具，点击生成帮助文档(Generate jabaD)

　　　　　　　　

 

　　　　　　2.选择我们要生成的类。

　　　　　　3.在output directory中选择我们刚才建立的存放JavaDoc的文件路径。

　　　　　　4.然后再Locale和其他命令行参数输入如下代码，以防止中文带来的乱码。

5.随即确认即可