Javadoc 识别@hide标记Tag之doclava

最近在开发java sdk, 但是sdk中的有些方法不想暴露给开发者。于是按照android的注释给这些接口

加上了@hide的标记,但是在生成javadoc的时候发现这些接口还是出现了。并且看到在生成javadoc的日志中

提示了@hide标签无法识别的错误。

百度了下,很多地方说要使用google的docklava。于是在网上找了很多方法,都失败了。

自己在github上搜索了下doclava然后根据其中的一个命令结合自己的工程最终测试成功。

下面说下步骤:

  1. 下载一个doclava的jar包:doclava1.0.6.
  2. 使用命令执行: javadoc -d 生成javadoc的目录 -package 包名 -doclet com.google.doclava.Doclava -docletpath /yourpath/doclava-1.0.6.jar -sourcepath src/main/java(代码目录) -subpackages 子包名 -classpath /home/tssh/workspace/Sdk/platforms/android-29/android.jar

有人问能否在android stuido的Generate JavaDoc里面添加命令参数去实现,个人去尝试过失败了,android studio的generate javadoc执行的指令顺序是写死的,即使我们将-doclet和docletpath加上去会有错误。所以目前只能按照上面的方式去生成可以识别@hide关键字的javadoc。

如果有谁知道android stuido里面如何配置,欢迎告诉我,谢谢。

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值