Java 文档注释

Java 文档注释用于描述类、方法、变量等的功能和用法，使用 /** ... */ 格式。

Java 文档注释

在 Java 中，文档注释（也称为 Javadoc）是一种用于生成 API 文档的注释格式，它可以帮助开发者更好地理解代码的功能和用法，同时也方便其他开发者快速查找和使用这些代码，本节将详细介绍 Java 文档注释的基本语法、标签和示例。

基本语法

Java 文档注释以 /** 开头，以 */ 结尾，在这两个标记之间，可以包含一些特殊的注释标签，用于描述类、方法、字段等元素的信息。

/**
 * 这是一个示例类。
 */
public class ExampleClass {
    // ...
}

常用标签

Javadoc 支持多种标签，用于描述不同类型的信息，以下是一些常用的标签：

1、@author：表示类的作者。

2、@since：表示自哪个版本开始使用此元素。

3、@version：表示元素的版本号。

4、@param：表示方法的参数。

5、@return：表示方法的返回值。

6、@throws：表示方法可能抛出的异常。

7、@see：表示与此元素相关的其他元素。

8、@link：表示指向其他资源的链接。

9、@deprecated：表示此元素已被废弃，不建议使用。

10、@serial：表示元素的序列化 ID。

11、@value：表示配置文件中的键值对。

12、@innerclass：表示内部类或嵌套类。

13、@outerclass：表示外部类或顶层类。

14、@summary：表示元素的简短描述。

15、@description：表示元素的详细描述。

16、@param：表示方法的参数。

17、@return：表示方法的返回值。

18、@throws：表示方法可能抛出的异常。

19、@exception：表示方法可能抛出的异常，已过时，建议使用 @throws 标签代替。

20、@note：表示与元素相关的额外信息。

21、@example：表示一个使用示例。

22、@requires：表示使用此元素所需的条件。

23、@ensures：表示此元素保证的结果。

24、@signal：表示此元素可能引发的信号事件。

25、@threadsafety：表示此元素的线程安全性。

26、@serial：表示元素的序列化 ID。

27、@serialData：表示元素的序列化数据。

28、@serialField：表示元素的序列化字段。

29、@indextable：表示元素在索引表中的位置。

30、@deprecated：表示此元素已被废弃，不建议使用。

31、@value：表示配置文件中的键值对。

32、@linkplain：表示指向其他资源的链接，类似于 Javadoc 的超链接功能。

33、@link：表示指向其他资源的链接，类似于 Javadoc 的超链接功能。

34、@since：表示自哪个版本开始使用此元素。

35、@param：表示方法的参数。

36、@return：表示方法的返回值。

37、@throws：表示方法可能抛出的异常。

38、@exception：表示方法可能抛出的异常，已过时，建议使用 @throws 标签代替。

39、@note：表示与元素相关的额外信息。

40、@example：表示一个使用示例。

41、@requires：表示使用此元素所需的条件。

42、@ensures：表示此元素保证的结果。

43、@signal：表示此元素可能引发的信号事件。

44、@threadsafety：表示此元素的线程安全性。

45、@serial：表示元素的序列化 ID。

46、@serialData：表示元素的序列化数据。

47、@serialField：表示元素的序列化字段。

48、@indextable：表示元素在索引表中的位置。

49、@deprecated：表示此元素已被废弃，不建议使用。

50、@value：表示配置文件中的键值对。

51、@linkplain：表示指向其他资源的链接，类似于 Javadoc 的超链接功能。

52、@link：表示指向其他资源的链接，类似于 Javadoc 的超链接功能。

53、@since：表示自哪个版本开始使用此元素。

54、@param：表示方法的参数。

55、@return：表示方法的返回值。

56、@throws：表示方法可能抛出的异常。

57、@exception：表示方法可能抛出的异常，已过时，建议使用 @throws 标签代替。

58、@note：表示与元素相关的额外信息。

59、@example：表示一个使用示例。

60、@requires：表示使用此元素所需的条件。

61、@ensures：表示此元素保证的结果。

62、@signal：表示此元素可能引发的信号事件。

63、@threadsafety：表示此元素的线程安全性。

64、@serial：表示元素的序列化 ID。

65、@serialData：表示元素的序列化数据。

66、@serialField：表示元素的序列化字段。

67、@indextable：表示元素在索引表中的位置。

68、@deprecated：表示此元素已被废弃，不建议使用。