如何编译生成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.

3.


  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

zqq_2016

有用的话,来打赏博主吧

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值