Java教程

JavaDoc

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

  • JavaDoc命令是用来生成自己API文档的，将写好的程序放在生成的文档中

  • 参数信息

    • @author 作者名
    • @version 版本号
    • @since 指明需要最早使用的jdk版本
    • @param 参数名
    • @return 返回值情况
    • @throws 异常抛出情况
package com.wyd.base;

/**
 * @author kuangshen
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */

    public String test(String name) throws Exception{
        return name;
    }
}

  • 打开所在文件夹

  • 在CMD中使用JavaDoc生成文档，javadoc -encoding UTF-8 -charset UTF-8 Doc.java

  • 生成文档的链接

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