java api 接口怎么编写?

2025-02-02 23:27:44
推荐回答(2个)
回答1:

其实原理和正常的接口没什么区别,主要是为了规范操作。

回答2:

Java语言提供了一种强大的注释形式:文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时可以先添加文档注释,然后使用javadoc工具来生成自己的API文档。

文档注释以斜线后紧跟两个星号(/**)开始,以星号后紧跟一个斜线(*/)作为结尾,中间部分全部都是文档注释,会被提取到API文档中。

自行搜索一下javadoc即可,示例如下:

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

/**
* 类描述
*
* @author 作者
* @version 版本
*/
public class DemoClass {
/**
* 内部属性:name
*/
private String name;

/**
* Setter方法
* @return name
*/
public String getName() {
return name;
}

/**
* Getter方法
* @param name
*/
public void setName(String name) {
this.name = name;
}

}