正文

自动生成api接口文档（自动生成api接口文档的框架）

发布时间：2023-06-01 10:09:36 稿源：创意岭阅读： 53

大家好！今天让创意岭的小编来大家介绍下关于自动生成api接口文档的问题，以下是小编对此问题的归纳整理，让我们一起来看看吧。

开始之前先推荐一个非常厉害的Ai人工智能工具，一键生成原创文章、方案、文案、工作计划、工作报告、论文、代码、作文、做题和对话答疑等等

只需要输入关键词，就能返回你想要的内容，有小程序、在线网页版、PC客户端和批量生成器

问友Ai官网：https://ai.de1919.com。

本文目录:

java api接口文档编写
如何试用eclipse 生成API帮助文档？
如何优雅的“编写”api接口文档
如何优雅的生成接口文档？

自动生成api接口文档（自动生成api接口文档的框架）

java api接口文档编写

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

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

自行搜索一下javadoc即可，示例如下：

/**
* 类描述
*
* @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;
}
}

如何试用eclipse 生成API帮助文档？

你已经完成了,95%的工作了.
就差最后这一哆嗦了.
话说,学java的那个不认识"谷老师"这是他给我的答案
方法有三：
1.选择工程，在菜单Project->Genarate Javadoc
2.选择工程，鼠标右键菜单Export ，选择Java 下面的Javadoc ，点”next” 按钮
3.选择工程，在菜单File->Export ，选择Java 下面的Javadoc ，点”next” 按钮
然后，可以选择生成到Javadoc 文档中的内容( 一般选public 或protected) ，选存放目录( 默认即可) ，next下一步 ,此页全默认即可，再next 下一步。
此时如果项目采用的是 UTF － 8 的编码，一定要在这一页的Extra Javadoc options 中加” -encoding UTF-8 -charset UTF-8 〃。否则生成的网页中文注释都是乱码。点 Finish 完成,
在工程的doc 目录中，就有Javadoc 文档了。

如何优雅的“编写”api接口文档

1. 拼写要准确
接口函数一旦发布就不能改了，要保持兼容性，拼写错误也不能改了，所以要仔细检查拼写，否则会被同行嘲笑很多年。
著名悲剧：unix 的 creat
2. 不仅是英文单词不要拼错，时态也不要错。
比如：
返回bool的判断函数，单数要用 is 复数要用are，这样你的命名就和文档中的描述保持了一致性。
表示状态的变量或者函数要注意时态，比如 onXxxxChanged 表示xxx已经变化了，isConnecting表示正在连接。
正确的时态可以给使用者传递更丰富的信息。
3. 函数最好是动宾结构
动宾结构就是 doSomething，这样的函数命名含义明确
比如： openFile, allocBuffer, setName
如果这个函数的动词宾语就是这个对象本身，那么可以省略掉宾语
4. 属性命名最好是定语+名词
比如 fileName, maxSize, textColor
5. 不要用生僻单词，这不是秀英语的地方，也不要用汉语拼音
比如：rendezvous，估计大多数人要去查词典才知道什么意思，这个词源自法语，是约会的意思。
Symbian OS里有个用它命名的函数，开发Symbian的是英国人，也许人家觉得很平常吧，反正我是查了词典才知道的。
6. 不要自己发明缩写
除非是约定俗成已经被广泛使用的缩写，否则老老实实用完整拼写。
坏例子: count->cnt, manager->mngr password->pw button->btn
现代的IDE都有很好的自动完成功能，名字长一点没关系的，可读性更重要。
7. 保持方法的对称性，有些方法一旦出现就应该是成对的，
比如有open就要有close，有alloc就要有free，有add就要有remove，这些单词基本是固定搭配的，使用者就很容易理解。
如果 open对应clear就有点让人困惑了。

自动生成api接口文档（自动生成api接口文档的框架）