如何编译生成API文档

之前编写代码都是比较随意的,也没有什么注释要占代码的1/3以上的概念,想写就写,不想写就不写,即使是写也是简单几个字,一笔带过。可能从心底就觉得,谁又会看我写的代码呢,渣渣~

一旦一个人的学习斗志被激发出来,那就是所谓的兴趣吧!我们一起来学习吧~

我们都知道代码的注释分为三种,笔者之前的编码生涯中也只是用过单行注释跟多行注释而已,以后就不同了,开启文档注释模式,生成属于自己项目的API文档,向终极boss进军。对于开发,每个人的习惯不同,编码方式也不尽相同。所以要时刻做好接受别人检阅我们代码的准备,首要任务就是做好注释。

我们现在用的最多的工具应该就是MyEclipse了,注意进入的目录,以及所建类所在路径即可。

D:\MyEclipse_Workspaces\CrazeJava>javadoc -d javaapi -header 测试的API -doctitle 这是我的第一个文档注释 -version -author src/zqq/trys/Test.java

对于EditPlus来说,是一样的道理。

D:\EditPlusProjects\crazyJava>javadoc -d javaapi -header 测试的API -doctitle 这是我的第一个文档注释 -version -author zqq/Test.java

效果图如下:

1.


2.

扫描二维码关注公众号,回复: 1216463 查看本文章

3.


猜你喜欢

转载自blog.csdn.net/zqq_2016/article/details/80234861