ToB企服应用市场:ToB评测及商务社交产业平台

标题: Javadoc(文档注释)详解！！！ [打印本页]

作者: 石小疯 时间: 2022-8-23 02:16
标题: Javadoc(文档注释)详解！！！
Javadoc(文档注释)

在之前提到过java有三行注释，而关于文档注释，在这里做一个详细的讲解
1.java文档注释的作用

文档注释只放在类、接口、成员变量、方法之前，以/*开始，/结束，我们可以通过javadoc生产API文档，来对类、成员变量、方法进行说明。API是我们可以直接调用，只需要了解其功能和使用方法，就可以直接拿上去使用。像，java中的Date，math等等。Api在java中就是一个类。
2.几种常用的Javadoc标签

Javadoc 工具可以识别文档注释中的一些特殊标签，这些标签一般以@开头，后跟一个指定的名字，有的也以{@开头，以}结束。Javadoc 可以识别的标签如下表所示：
标签作用@author标识一个类的作者@param方法的参数@return标明返回值类型，一般用于方法注释，不能出现再构造方法中{@value}显示常量的值，该常量必须是 static 属性。@since版本号，标明从哪个版本起开始有这个函数@version指定类的版本@exception可能抛出异常的说明，一般用于方法注释@throws也是可能抛出异常的说明@serial说明一个序列化属性@serialData说明通过 writeObject() 和 writeExternal() 方法写的数据@serialField说明一个 ObjectStreamField 组件3.java生产doc文档

我们使用的函数都是之前的前辈们，创建的，那么如何去生产doc文档呢？主要有两种方法
使用dos命令生产doc文档

Ⅰ.首先我们创建一个Doc.java的文件，也就是类，再给文件添加一些注释，写两个方法
代码如下：
[code]public class Doc { String name; int n=5; int m=6; /** * @author ling * @version jdk1.8.0 * @since 1.0 * @param n * @param m * @return */ public int add(int n, int m) { int sum = 0; if (n

欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/)