JavaDoc文档注释
/**
* @author Chenyan
* @version 1.0
* @since 1.8
*/
public class Doc {
//属性
String name;
/**
* @author Chenyan
* @param name
* @return
* @throws Exception
*/
//方法
public String tese(String name) throws Exception{
return name;
}
@author作者名
@version版本号
@since指明需要最早使用的jdk版本
@param参数名
@return返回值情况
@throws 异常抛出情况
注释后可以生成类似API的东西
1.先打开所在地址

2.在地址前面输入CMD

3.输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java 后回车

4.生成很多文件,打开一个叫index的html

本文档介绍了如何使用JavaDoc来为Java类和方法创建API文档。通过在代码中添加@author, @version, @since, @param, @return和@throws等注解,然后在命令行中运行javadoc命令,可以自动生成详细的HTML文档。步骤包括:打开CMD,输入指定命令,最终生成的HTML文件中包含了类和方法的详细信息。
7821

被折叠的 条评论
为什么被折叠?



