让自己写的程序也有api

当我们在学习的时候,有时候看到别人的api会感觉到蛮高大上的。其实他们的api并不是他们在写完程序之后,通过键盘录入的,而是通过工具来生生成的。因此我们完全有机会打造属于自己的api。

api的作用

1. 便于团队人员使用你写的程序/框架
2. 让维护人员可以更好的定位
3. 可以让不懂技术的人看起来很高大上,显得专业

生成api的一些必要条件

1. 了解相应的api生成的官方注释(即:@author 曾亮辉,表示作者是曾亮辉)
2. 有良好写注释的习惯

后端(java)生成api的步骤

使用eclipse工具

1. 右击项目 export 选择java–>javadoc

这里写图片描述

2. 选择需要生成的程序代码和保存生成文件的目录

这里写图片描述

3. 选择是否将相应的jar包导入

这里写图片描述

4. 选择编码格式和jre版本

这里写图片描述

生成效果

这里写图片描述

http://blog.csdn.net/yongh701/article/details/43153191 使用Eclipse生成API文档

前端(js)生成api文档

https://my.oschina.net/lsjcoder/blog/1583072 五分钟玩转文档化工具JSDuck

效果(文章内的图,本人并未亲自验证)

这里写图片描述

©️2020 CSDN 皮肤主题: 创作都市 设计师:CSDN官方博客 返回首页