Java教程

JavaDoc生成文档

本文主要是介绍JavaDoc生成文档，对大家解决编程问题具有一定的参考价值，需要的程序猿们随着小编来一起学习吧！

JavaDoc

*javadoc命令是用来生产自己API文档的

//命令行生成方式 javadoc 参数 java文件

//IDEA生成方式

1.选中要生成api文档的项目，模块，类->点击tools->打开Generate javaDoc...
2.设置路径和编码格式（-encoding utf-8 -charset utf-8）

*参数信息

*@author作者名

*@version版本号

*@since指明需要最早使用的jdk版本

*@param参数名

*@return返回值情况

*@throws异常抛出情况

package com.zy.base;
​
/**
 * @author zhangyu
 * @version 1.0
 * @since 1.8
 */
public class Doc {
​
    String name;
​
​
    /**
     * @author zhangyu
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

 

这篇关于JavaDoc生成文档的文章就介绍到这儿，希望我们推荐的文章对大家有所帮助，也希望大家多多支持为之网！
您可能喜欢
栏目导航