JavaDoc
javadoc命令是用来生成自己的API文档的
参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
package jk;
/**
* @author zsy
* @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;
}
}
- 通过命令行生成JavaDoc
- 找到此文档所对应的文件位置
- 在文件地址栏前+cmd+空格,然后回车进入DOS命令
- Dos:
**-encoding UTF-8 -charset UTF-8**
编码为UTF-8 字符集也为UTF-8
这段代码是为了让文章更多的显示中文,让文章更优秀,尽量不出现乱码。
- **程序运行完之后,打开文件所在的文档找到
- 这就是JavaDos生成的文档
作业
**学会查找使用IDEA生产JavaDoc文档, 面向百度程序