Java中注释/**@hide*/的初步认识

今天写一个调节系统背光亮度的时候，参考了Android中的Setting源码，在源码中有这么一段代码：

?

1

privatestatic final int MAXIMUM_BACKLIGHT = android.os.PowerManager.BRIGHTNESS_ON;

然后我模仿它的代码，来进行编写我的应用，但是当我copy这段代码后报错

报错内容如下：

?

1

BRIGHTNESS_ON cannot be resolved or is not a field

然后我去察看源代码，发现定义如下：

?

1

2

3

4

5

/**

* Brightness value for fully on.

* @hide

*/

publicstatic final int BRIGHTNESS_ON = 255;

明显声明为public，怎么可能会访问不到呢？再细看注释，发现里面有“@hide”这个标志。后来百度一下才认识到，类或API是否开放，是通过doc的注释｛＠hide｝来控制的。这表示不对外公开api，但是系统内部是可以使用该注释标记的接口的。

google 给了两个选择:1. 在你添加的API或者变量前面，增加javadoc 注释＠hide。但是要注意的是，并不是简单写个＠hide 或者 /*@hide*/ 就可以了，这些都是错误的javadoc注释格式，标准的javadoc都是这样的 /** */ 而且对于 format 变量 应该加上 { }。所以我们应该这样写 /** {@hide} */ 2. 你就是想要生成的javadoc里面出现这个方法或者变量，你必须输入:make update-api 但是如果修改的是google没有开放出来的类，比如RIL，PhoneFactory，就不会出现这个问题。

如何解决这个报错的问题呢，问了一下公司的前辈，前辈是这么解释的，加入了 /** {@hide} */ 注视后的类或者API是google编译时不对外开放的，但是运行的时候这写类和API都是可以访问的。为了在Eclipse中不报错的话，可以准备以下几步就可以不报错了。

1，准备好编译后的Android源码。
2，在该源码的out目录下寻找包含你所用隐藏类的jar文件，通常文件名为classes.jar。例如framework的jar文件为out argetcommonobjJAVA_LIBRARIES ramework_intermediatesclasses.jar。

3，在eclipse的Android项目中，选择项目属性->Java Build Path->Libraries->Add Library->User Library->Next-> UserLibraries进入到User Libraries管理界面，点击New新建一个User Library，比如android_framework，点击Add Jars把Jar包加入到建立的User Library中，最后点击OK就可以了。

现在在Eclipse中就不会再报错了。

====================================================================================

作者：欧阳鹏 欢迎转载，与人分享是进步的源泉！

转载请保留原文地址：http://blog.csdn.net/ouyang_peng