Mrli
别装作很努力,
因为结局不会陪你演戏。
Contacts:
QQ博客园

javadoc——让大家更好写java项目

2022/03/09 技能糖
Word count: 2,331 | Reading time: 10min

近期在Github上看到一个有趣的项目，是各个技能树的挑战，并且起了个冒险岛的故事——字节传说:勇士将无惧挑战。其中除了提交Pr的教程（挑战）外，还有个比较有意思的是Javadoc，想想之前没专门写过，于是本勇士本次就毅然接收了Javadoc的挑战。

Javadoc

很多程序对Javadoc都不重视，认识不到Javadoc的作用，很多人都是这样认为的：“我只要写好功能就够了，写Javadoc太浪费时间，也没啥作用，还不如用写Javadoc的时间再多些个功能呢！”，我们知道注释是为了解释代码的作用的，是为了将来给自己或者别人快速了解代码的，在方法内一般用行注释//的比较多，是针对一小块代码做出解释的，而Javadoc的作用是针对整个方法或者整个类做一个简要的概述的，使得别人不通过看具体方法代码就能知道某个方法或者某个类的作用和功能。写了Javadoc的在别人使用到类时，将鼠标悬停到类上或者方法上，javadoc会以提示信息显示出来，这样开发者在跳进源代码中就能知道类或者方法的作用，使得可以编在码时看文档，效果最明显的就是Spingboot的Javadoc能在不知道一个接口的作用、参数时，直接看到说明。

1
2
3
4
5
6
7
/**												
 * <概要描述>
 * 
 * <详细描述>
 * 
 * <Javadoc文档标记 标记说明>
 * /

注意点：①Javadoc以/**开头，*/收尾；②文档标记后不能跟冒号:，如@param filePath中间用空格分开即可，不能加:

  • 第一段：概要描述，通常用一句或者一段话简要描述该类或者方法的作用
  • 第二段：详细描述，通常用一段或者多段话来详细描述该类或者方法的作用
  • 第三段：文档标注，用于标注作者、创建时间、参阅类、参数等信息

常见Javadoc文档标记

JDK预定义好的文档标记有，@author、@version、@since、@see、@link、@code、@param、@return、@exception、@throws等。

{@link 包名.类名#方法名(参数类型)}用于快速链接到相关代码

@link的使用语法{@link 包名.类名#方法名(参数类型)}，其中当包名在当前类中已经导入了包名可以省略，可以只是一个类名，也可以是仅仅是一个方法名，也可以是类名.方法名，使用此文档标记的类或者方法，可用通过 按住Ctrl键+单击 可以快速跳到相应的类或者方法上，解析成html其实就是使用< code> 包名.类名#方法名(参数类型)< /code>

1
2
3
4
5
6
7
8
9
10
11
// 完全限定的类名
{@link java.lang.Character}

// 省略包名
{@link String}

// 省略类名，表示指向当前的某个方法
{@link #length()}

// 包名.类名.方法名(参数类型)
{@link java.lang.String#charAt(int)}

@code：

{@code text} 将文本标记为code

{@code text} 会被解析成<code> text </code>。将文本标记为代码样式的文本，在code内部可以使用 < 、> 等不会被解释成html标签, code标签有自己的样式，一般在Javadoc中只要涉及到类名或者方法名，都需要使用@code进行标记。

@see

另请参阅，一般用于标记该类相关联的类（方法）、相似的类（方法）

@see即可以用在类上，也可以用在方法上。

1
2
3
4
5
6
7
/**
 * @see IntStream
 * @see LongStream
 * @see DoubleStream
 * @see <a href="package-summary.html">java.util.stream</a>
 * /
public interface Stream<T> extends BaseStream<T, Stream<T>> {}

@throws

后面跟 异常类型 异常描述 , 用于描述方法内部可能抛出(产生)的异常

1
2
3
4
/**
* @param str the {@code CharSequence} to check (may be {@code null})
*/
public static boolean containsWhitespace(@Nullable CharSequence str) {}

@exception

用于描述方法签名明确会throws的异常

1
2
3
4
/**
* @exception IllegalArgumentException if <code>key</code> is null.
*/
public static Object get(String key) throws IllegalArgumentException {}

@value

用于标注在常量上，{@value} 用于表示常量的值

1
2
/** 默认数量 {@value} */
private static final Integer QUANTITY = 1;

@inheritDoc

@inheritDoc用于注解在重写方法或者子类上，用于继承父类中的Javadoc

  • 基类的文档注释被继承到了子类
  • 子类可以再加入自己的注释（特殊化扩展）
  • @return @param @throws 也会被继承

@version

@version 用于标记当前版本，默认为1.0

1
2
3
4
5
package com.sun.org.apache.xml.internal.resolver;
 /**
 * @version 1.0
 */
public class Resolver extends Catalog {}

@since

@since 一般用于标记文件创建时项目当时对应的版本，一般后面跟版本号，也可以跟是一个时间，表示文件当前创建的时间

@return

返回值的描述

@param

后面跟参数名，再跟参数描述

完整示例

spring-core中的StringUtils 示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
package org.springframework.util;

/**
 * Miscellaneous {@link String} utility methods.
 *
 * <p>Mainly for internal use within the framework; consider
 * <a href="http://commons.apache.org/proper/commons-lang/">Apache's Commons Lang</a>
 * for a more comprehensive suite of {@code String} utilities.
 *
 * <p>This class delivers some simple functionality that should really be
 * provided by the core Java {@link String} and {@link StringBuilder}
 * classes. It also provides easy-to-use methods to convert between
 * delimited strings, such as CSV strings, and collections and arrays.
 *
 * @author Rod Johnson
 * @author Juergen Hoeller
 * @author Keith Donald
 * @author Rob Harrop
 * @author Rick Evans
 * @author Arjen Poutsma
 * @author Sam Brannen
 * @author Brian Clozel
 * @since 16 April 2001
 */
public abstract class StringUtils {

	/**
	 * Decode the given encoded URI component value. Based on the following rules:
	 * <ul>
	 * <li>Alphanumeric characters {@code "a"} through {@code "z"}, {@code "A"} through {@code "Z"},
	 * and {@code "0"} through {@code "9"} stay the same.</li>
	 * <li>Special characters {@code "-"}, {@code "_"}, {@code "."}, and {@code "*"} stay the same.</li>
	 * <li>A sequence "{@code %<i>xy</i>}" is interpreted as a hexadecimal representation of the character.</li>
	 * </ul>
	 * 
	 * @param source the encoded String
	 * @param charset the character set
	 * @return the decoded value
	 * @throws IllegalArgumentException when the given source contains invalid encoded sequences
	 * @since 5.0
	 * @see java.net.URLDecoder#decode(String, String)
	 */
	public static String uriDecode(String source, Charset charset) {}

导出JavaDoc

命令行导出
javadoc.exe -private -splitindex -author -charset UTF-8 -encoding UTF-8 -windowtitle 柳州交通仿真Doc -d F:\TODO\sucsoft\code\lzjt-simulation\javadoc @G:\os_tmp\javadoc_args
  • -windowtitle : 页面的header-title
  • -d: 输出目录
  • -charset、-encoding：中文乱码解决方法
  • -overview <文件> 读取 HTML 文件的概述文档
  • -public 仅显示公共类和成员
  • -protected 显示受保护/公共类和成员（默认）
  • -package 显示软件包/受保护/公共类和成员
  • -private 显示所有类和成员
  • -help 显示命令行选项并退出
  • -doclet <类> 通过替代 doclet 生成输出
  • -docletpath <路径> 指定查找 doclet 类文件的位置
  • -sourcepath <路径列表> 指定查找源文件的位置
  • -classpath <路径列表> 指定查找用户类文件的位置
  • -exclude <软件包列表> 指定要排除的软件包的列表
  • -subpackages <子软件包列表> 指定要递归装入的子软件包
  • -breakiterator 使用 BreakIterator 计算第 1 句
  • -bootclasspath <路径列表> 覆盖引导类加载器所装入的类文件的位置
  • -source <版本> 提供与指定版本的源兼容性
  • -extdirs <目录列表> 覆盖安装的扩展目录的位置
  • -verbose 输出有关 Javadoc 正在执行的操作的消息
  • -locale <名称> 要使用的语言环境，例如 en_US 或 en_US_WIN、ZN_CN
  • -encoding <名称> 源文件编码名称
  • -quiet 不显示状态消息
  • -J<标志> 直接将 <标志> 传递给运行时系统
  • -X 输出非标准选项的提要

标准doclet选项 说明

  • -d <directory>输出文件的目标目录
  • -use创建类和程序包用法页面
  • -version包含 @version 段
  • -author包含 @author 段
  • -docfilessubdirs 递归复制文档文件子目录
  • -splitindex将索引分为每个字母对应一个文件
  • -windowtitle <text>文档的浏览器窗口标题
  • -doctitle <html-code>包含概览页面的标题
  • -header <html-code>包含每个页面的页眉文本
  • -footer <html-code>包含每个页面的页脚文本
  • -top <html-code>包含每个页面的顶部文本
  • -bottom <html-code>包含每个页面的底部文本
  • -link 创建指向位于<url>的 javadoc 输出的链接

from:java基础(4)–javadoc文档与命令

IDEA导出

generateJavadoc

附录：

使用HTML标签写详细文档：

第二段：详细描述

详细描述一般用一段或者几个锻炼来详细描述类的作用，详细描述中可以使用html标签，如<p>、<pre>、<a>、<ul>、<i>等标签， 通常详细描述都以段落p标签开始。
详细描述和概要描述中间通常有一个空行来分割

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package org.springframework.util;

/**
 * Miscellaneous {@link String} utility methods.
 *
 * <p>Mainly for internal use within the framework; consider
 * <a href="http://commons.apache.org/proper/commons-lang/">Apache's Commons Lang</a>
 * for a more comprehensive suite of {@code String} utilities.
 *
 * <p>This class delivers some simple functionality that should really be
 * provided by the core Java {@link String} and {@link StringBuilder}
 * classes. It also provides easy-to-use methods to convert between
 * delimited strings, such as CSV strings, and collections and arrays.
 *
 */
public abstract class StringUtils {

一般段落都用p标签来标记，凡涉及到类名和方法名都用@code标记，凡涉及到组织的，一般用a标签提供出来链接地址。

package-info.java

包级注释

1
2
3
// package-info.java
@Deprecated			// 加上了后，该包下的所有方法都会提供 过期
package top.nymrli.test;

Author: Mrli

Link: https://nymrli.top/2021/10/17/javadoc——让大家更好写java项目/

Copyright: All articles in this blog are licensed under CC BY-NC-SA 3.0 unless stating additionally.

< PreviousPost
Java LoggerNextPost >
ZJU开学摸底考试——计算机网络复习
CATALOG
  1. 1. Javadoc
    1. 1.1. 常见Javadoc文档标记
    2. 1.2. @link：
    3. 1.3. @code：
    4. 1.4. @see
    5. 1.5. @throws
    6. 1.6. @exception
    7. 1.7. @value
    8. 1.8. @inheritDoc
    9. 1.9. @version
    10. 1.10. @since
    11. 1.11. @return
    12. 1.12. @param
  2. 2. 完整示例
  3. 3. 导出JavaDoc
  4. 4. 附录：
    1. 4.1. 第二段：详细描述
    2. 4.2. package-info.java