狂神说JAVA 基础语法注释 JavaDoc

wangzi123wyj

已于 2022-09-28 22:17:18 修改

阅读量33

点赞数

分类专栏： 03 Java 基础语法文章标签： java 开发语言后端

于 2021-06-20 22:16:33 首次发布

本文链接：https://blog.csdn.net/wangzi123wyj/article/details/118003099

版权

03 Java 基础语法专栏收录该内容

5 篇文章 0 订阅

订阅专栏

注释

单行注释 // Ctrl+/
多好注释 /* */

JavaDoc

文档注释/**
* 111
* 222
* @author
* @version
* @since 1.8 指明需要最早使用的JDK版本
* @param 参数名
* @return 返回值情况
* @throw 异常抛出情况
*/

手动
	IDEA 右键 Show In Explorer，确定目录
	CMD 进入目录 JAVADOC -ENCODING UTF-8 -CHARSET UTF-8 xxx.java	
	会生成index.html
IDEA
	在工具栏中找到 tool >> Generate JAVADoc
	参数说明 
1. Whole project>>整个项目都生成 
2. Custom scope>>自定义范围，如下：project files 项目文件，project production files 项目产品文件，project test files 项目的测试文件， 未知范围，class hierarchy 类层 
选择 
3. include test source 包含测试目录 
4. include JDK and … 包含jdk和其他的第三方jar 
5. link to JDK documentation…链接到JDK api 
6. output directy 生成的文档存放的位置 
7. private、package、protected、public 生成文档的级别（类和方法） 
8. 右边的Generate…是选择生成的文档包含的内容，层级树、导航、索引.. 
9. 再右边是生成的文档包含的内容信息，作者版本等信息 
10. Locale 语言类型,zh-CN 
11. Other command line arguments 其他参数 
12. Maximum heep… 最大堆栈