Javadoc 识别@hide标记Tag之doclava

原创 于 2021-01-16 13:52:09 发布 · 807 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#android

在开发Java SDK时，遇到需要隐藏某些方法不暴露给开发者的问题。通过添加@hide注解但发现javadoc仍显示这些接口。解决方法是使用Doclava工具。详细步骤包括下载doclava jar包，使用特定命令行生成javadoc，避开Android Studio内置生成的限制。虽然尝试在Android Studio内配置未成功，但命令行方式已能有效隐藏@hide标记的方法。如果你知道如何在Android Studio中配置，欢迎分享。

最近在开发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<
最低0.47元/天 解锁文章
IDEA 生成方法注释 加入所有参数到注释并填写参数默认值同时生成javadoc文档@param注解当成字符串解理
江西DJ烟仔的博客
07-06 4219
由于想规范下一下项目的注释, 所以首先得规范一下IDEA的注释模板, 创建类跟在方法上的注释模板怎么设置我就不说了, 网上太多的教程了, 我在这里要说的是稍微高级一点的 如何个性化 自定义 我的方法注释模板如下 $params$ 参数的定义在右边的编辑变量里 params 里面的代码是从一些你抄我, 我抄你的播客中复制过来的如下 groovyScript("def result...
Eclipse javadoc生成发生的错误
一夜星尘
10-19 7533
一个是编码问题，比如会出现如下类似的警告： 解决方案： 在javadoc generator Next两次后的界面输入以下代码： -encoding utf-8 -charset utf-8 如图： 如果出现
Android 系统javadoc符 注释/**@hide*/
weixin_33720956的博客
09-30 385
  google 给了两个选择:1. 在你添加的API或者变量前面，增加javadoc 注释＠hide。但是要注意的是，并不是简单写个＠hide 或者 /*@hide*/ 就可以了，这些都是错误的javadoc注释格式，标准的javadoc都是这样的 /** */ 而且对于 format 变量 应该加上 { }。所以我们应该这样写 /** {@hide} */ 2. 你就是想要生成的javado...
Java中注释/**@hide*/的初步认识
大雄不爱吃肉
07-18 8445
今天写一个调节系统背光亮度的时候，参考了Android中的Setting源码，在源码中有这么一段代码： ? 1 private static final int MAXIMUM_BACKLIGHT = android.os.PowerManager.BRIGHTNESS_ON; 然后我模仿它的代码，来进行编写我的
android框架Java API接口总注释/**@hide*/和internal API
weixin_34015860的博客
06-30 2331
Android有两种类型的API是不能经由SDK访问的 l第一种是位于com.android.internal包中的API我,位于frameworks/base/core/java/com/android/internal/。我将称之为internal API。 l第二种API类型是一系列被标记为@hide属性的类和方法。从严格意义上来讲，这不是一个单一的API和类，而是一些的被隐藏的AP...
Doclava：来自Google的自定义Javadoc Doclet
最佳 Java 编程
05-06 953
Doclava是Google的自定义Javadoc Doclet，由Google Guice使用（请参阅稍冷的 Javadocs ）。 Doclava使用JSilver作为其模板引擎，这是Clearsilver的纯Java实现。 我个人喜欢联合文档的想法，它允许文档在打开的项目上相互链接和集成。 这是Doclava与标准Doclet之间的主要区别： 刷新后的外观，包括搜索功能。 ...
javadoc2swagger：将Javadoc转换为-读取自定义javadoc标记并生成一个swagger文件
02-04
Maven插件，用于从JAX-RS和Javadoc注释生成Swagger 这个Maven插件正在为基于JAX-RS的Java服务器生成Swagger API文档。 JAX-RS批注中未包含的其他信息放置在Javadoc注释中。 例 此处提供了一个使用javadoc2swagger-...
详解IDEA自定义注释模板(javadoc)
08-27
IDEA自定义注释模板(javadoc)详解 IDEA自定义注释模板(javadoc)是指在IntelliJ IDEA中自定义Java文档注释模板，以满足项目的编码风格和需求。本文将介绍两种自定义注释模板的解决方案：安装Jindent插件和使用IDEA...
为android开放类增加自定义成员方法[转]
Giegie的专栏
08-08 996
android SDK中有些JAVA类是开放的，有些是不开放的，API同样如此。这里所谓开放的类或API，只是javadoc的范畴，并不是java中public和private，也就是说，对于源码的编译无所谓，但是对android的上层应用有影响，因为非开放的类或API,andr
javadoc: error - java.lang.reflect.InvocationTarget Exception java.lang.NullPointerException
u011603302的专栏
02-29 2844
编译update-api时报错如下(截取了出错部分的那段log)： Copying: out/target/common/obj/JAVA_LIBRARIES/android-support-v7-mediarouter_intermediates/emma_out/lib/classes-jarjar.jar Copying: out/target/common/obj/JAVA_LIBRA
Android编译顺序
persuit的专栏
05-17 1万+
引言： 编译android时，第一个编译的是jsr305lib，一直很好奇，终于有时间分析下原因了； 拷贝到本地，设置为不自动换行，阅读跟方便； 第一部分：整体次序 1 .PHONY: droid DEFAULT_GOAL := droid $(DEFAULT_GOAL): 终极目标为droid； 2.droid: droidcore dist_libraries 3
maven-javadoc-plugin打包错误：未知标记：date
p7+的博客
05-22 6192
错误信息 在使用maven-javadoc-plugin打包的过程时，要区分jdk1.7和jdk1.8，因为maven-javadoc-plugin插件在jdk1.8的时候要加一个配置项，否则生成javadoc时，会报错 插件正确配置 方式一：写死配置 <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</arti
javaDoc和java文件的注释以及javadoc生成出现的问题【dos option选项】
热门推荐
sinat_32955803的博客
05-03 1万+
参考文章，百度百科                     http://88250.b3log.org/when-the-little-things-count-javadoc                     javadoc的查看帮助文档：http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html
[译]Android注解--@hide
liken的专栏
03-13 7623
@hide
@SystemApi @hide @NonNull @TargetApi
caopeng的专栏
10-10 1万+
SystemApi hide NonNull TargetApi PrivateApi
@hide怎么使用
最新发布
08-26
### `@hide` 注解在 Java 中的使用方法和示例 `@hide` 并不是 Java 标准注解，而是 Android 源码中自定义的一种注释标记，用于控制 API 文档的生成。它通常被用于隐藏某些类、方法或字段，使其不在生成的 SDK 文档中显示，从而防止开发者直接使用这些非公开 API。尽管 `@hide` 不属于 Java 原生注解体系，但其使用方式与标准注解类似，通常以 Javadoc 注释的形式出现在代码中[^1]。 #### 使用方法 `@hide` 通常以 `/** @hide */` 的形式出现在类、方法或字段的注释中。它不会影响编译过程，也不会对运行时行为产生任何作用，仅用于控制 API 文档的生成。例如： ```java /** @hide */ public class HiddenClass { // 类内容 } ``` 上述代码中，`HiddenClass` 被标记为 `@hide`，因此在生成的 SDK 文档中不会出现该类的描述。同样地，也可以将 `@hide` 应用于方法或字段： ```java public class Example { /** @hide */ public void hiddenMethod() { // 方法实现 } } ``` 这种方式可以有效隐藏某些尚未稳定或不推荐使用的 API，避免开发者误用[^1]。 #### 示例说明 在 Android 系统源码中，`@hide` 被广泛用于隐藏内部 API。例如，在 `ActivityManager` 类中存在如下方法定义： ```java /** @hide */ public static int checkUidPermission(String permission, int uid) { try { return AppGlobals.getPackageManager().checkUidPermission(permission, uid); } catch (RemoteException e) { Slog.e(TAG, "PackageManager is dead?!?", e); } return PackageManager.PERMISSION_DENIED; } ``` 上述方法虽然在系统源码中是公开的，但由于被标记为 `@hide`，它不会出现在 Android SDK 的官方文档中。开发者无法通过常规方式访问该方法，但可以通过反射机制调用它。需要注意的是，这种访问方式存在兼容性风险，因为隐藏 API 可能在未来的版本中被移除或修改[^1]。 #### 开发建议 尽管 `@hide` 提供了一种隐藏 API 的机制，但它并不具备访问控制能力。开发者应避免依赖这些隐藏 API，因为它们可能在不同设备或系统版本中表现不一致。若确实需要访问隐藏 API，可以通过反射或替换 `android.jar` 的方式实现，但这种方式不推荐用于正式发布的应用中，以免引发兼容性问题[^1]。 ---
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值