用命令提示符生成文档

创建Doc类,编辑版本,作者,参数信息等

能写的参数信息:

@author 作者名

@version 版本号

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

@param 参数名

@return 返回值情况

@throws 异常抛出情况

package base;

/**
 * @author wcs
 * @version 1.0
 * @since 1.8
 */

public class Doc {
    String name;

    /**
     *
     * @author wcs
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }

}

在命令提示符里打开Dos类所在的包:

然后输入这串代码:javadoc -encoding UTF8 -charset UTF-8 Doc.java

执行结果:

打开此文件:

最后能看见生成的自己的API文档

Logo

开源鸿蒙跨平台开发社区汇聚开发者与厂商,共建“一次开发,多端部署”的开源生态,致力于降低跨端开发门槛,推动万物智联创新。

更多推荐