JavaDoc

JavaDoc

• javadoc命令是用来生成自己API文档的

 

参数信息

• @author 作者名

• @version 版本号

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

• @param 参数名

• @returm 返回情况

• @throws 异常抛出情况

package com.rong.base;
​
/**
 * @author xiaotang
 * @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;
        //通过Dos命令窗口，数入javadoc 参数 java文件，可成javadoc文档（参数：-encoding UTF-8 -charset UTF-8）
    }
}
​

 

__EOF__

本文作者：小瑭
本文链接：https://www.cnblogs.com/ywwd/p/15781184.html
关于博主：评论和私信会在第一时间回复。或者直接私信我。
版权声明：本博客所有文章除特别声明外，均采用 BY-NC-SA 许可协议。转载请注明出处！
声援博主：如果您觉得文章对您有帮助，可以点击文章右下角【推荐】一下。您的鼓励是博主的最大动力！