JavaDoc简单使用

常用参数：
@author
@version
@since
@param
@return
@throws
…
示例

import java.io.IOException;

/**
 * @author cbcxy
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    private String name;

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

使用命令生成文档

在cmd输入以下命令

javadoc -encoding UTF-8 -charset UTF-8 -d C:\Users\cbcxy2024\Desktop\temp\doc .\Doc.java

-encoding UTF-8 -charset UTF-8：防止中文乱码
-d C:\Users\cbcxy2024\Desktop\temp\doc：文档生成路径，没选默认在本目录

使用idea生成文档

Tools->Generate JavaDoc

注意
OutPut directory
Command line arguements

更多

https://www.cnblogs.com/mrwhite2020/p/13379707.html