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
-
生成文档的链接
作者:wangyudong
本文版权归作者和博客园共有,欢迎转载,但必须给出原文链接,并保留此段声明,否则保留追究法律责任的权利。