- 1
- 2
- 3
- 4
- 5
Javadoc规范-代码文档生成.docx
资料介绍
一、Javadoc概述
Javadoc是Java语言特有的文档生成工具，能够从Java源代码中提取注释信息，自动生成HTML格式的API开发文档。遵循统一的Javadoc规范，可以保证生成的文档结构清晰、信息完整，帮助开发者快速理解代码的设计意图、使用方法和注意事项，降低团队协作的沟通成本，同时也为后续代码维护和版本迭代提供可靠的文档支撑。
二、基本格式要求
2.1 注释结构
标准Javadoc注释以/**开头，以*/结尾，每一行开头可加可选的星号*，星号后需保留一个空格，保证排版整齐。基本结构分为三个部分：描述文本、块标记区、空行分隔，具体格式如下：
/** 描述该类、方法或字段的功能说明
* <p>详细描述补充说明，可分段使用p标签区分段落</p>
*
* @块标记 标记内容
*/
2.2 HTML标签使用规范
Javadoc支持内嵌HTML标签来丰富文档格式，常用标签及使用规则如下：
· 使用<p>标签分隔段落，不要直接换行，保证不同解析器渲染效果一致；
· 使用<ul>、<ol>和<li>实现列表，展示分点说明内容；
· 使用<code>标记代码片段，使用<pre>标记多行代码块；
部分文件列表
| 文件名 | 大小 |
| Javadoc规范-代码文档生成.docx | 20K |
最新上传
- 打赏
- 30日榜单
-
21下载积分 打赏310.00元 3天前
用户：江岚
-
21下载积分 打赏310.00元 3天前
用户：潇潇江南
-
21下载积分 打赏60.00元 3天前
用户：他山之石可攻玉
-
21下载积分 打赏310.00元 3天前
用户：小猫做电路
-
21下载积分 打赏210.00元 3天前
用户：zhengdai
-
21下载积分 打赏210.00元 3天前
用户：w993263495
-
21下载积分 打赏10.00元 3天前
用户：烟雨
-
21下载积分 打赏60.00元 3天前
用户：gsy幸运
-
21下载积分 打赏70.00元 3天前
用户：铁蛋锅
-
21下载积分 打赏65.00元 3天前
用户：xzxbybd
-
21下载积分 打赏60.00元 3天前
用户：jh0355
-
21下载积分 打赏60.00元 3天前
用户：w178191520
-
21下载积分 打赏20.00元 3天前
用户：jh03551
-
21下载积分 打赏20.00元 3天前
用户：sun2152
-
21下载积分 打赏20.00元 3天前
用户：kk1957135547
-
21下载积分 打赏25.00元 3天前
用户：w1966891335
-
21下载积分 打赏20.00元 3天前
用户：xuzhen1
-
21下载积分 打赏15.00元 3天前
用户：x15580286248
-
21下载积分 打赏25.00元 3天前
用户：pcb
-
21下载积分 打赏20.00元 3天前
用户：bhacker
-
21下载积分 打赏15.00元 3天前
用户：liqiang9090
-
21下载积分 打赏25.00元 3天前
用户：有理想666
-
21下载积分 打赏15.00元 3天前
用户：godbox
-
21下载积分 打赏15.00元 3天前
用户：aetek
-
21下载积分 打赏5.00元 3天前
用户：mulanhk
-
21下载积分 打赏5.00元 3天前
用户：JuneLin61
-
21下载积分 打赏5.00元 3天前
用户：ccc6188
-
21下载积分 打赏5.00元 3天前
用户：木集盒
-
21ic小能手 打赏5.00元 3天前
-
21ic小能手 打赏5.00元 3天前
-
21ic小能手 打赏3.00元 3天前
-
21ic小能手 打赏5.00元 3天前
-
21ic小能手 打赏5.00元 3天前
-
21ic小能手 打赏3.00元 3天前
-
21ic小能手 打赏5.00元 3天前
-
21ic小能手 打赏10.00元 3天前
-
21ic小能手 打赏8.00元 3天前
-
21ic小能手 打赏5.00元 3天前
-
21ic小能手 打赏5.00元 3天前
-
21ic小能手 打赏5.00元 3天前
全部评论(0)