@remove 在 Android 框架中的 javadoc 中意味着什么
What does @remove mean in javadoc in Android framework
我一直在检查 android sdk 中的 ContextWrapper.java
,并注意到 @remove
在 javadoc 中注释了一些方法。我假设,它是在 IDE 中发出 lint 警告的一个指标,但最好知道它到底是什么以及为什么他们首先需要这样的东西而不是完全删除。
/** @removed */
@Override
public SharedPreferences getSharedPreferences(File file, int mode) {
return mBase.getSharedPreferences(file, mode);
}
像@hide
一样,它导致Doclava(一个Javadoc doclet Android用于生成SDK文档和API签名文本文件)从生成的文件中省略带注释的成员文档,如果传递了 -api
标志,则来自生成的 API 签名文本文件。如果还使用 -removedApi
标志,则注释 @remove
的成员将包含在 removed.txt 签名文件中。
我一直在检查 android sdk 中的 ContextWrapper.java
,并注意到 @remove
在 javadoc 中注释了一些方法。我假设,它是在 IDE 中发出 lint 警告的一个指标,但最好知道它到底是什么以及为什么他们首先需要这样的东西而不是完全删除。
/** @removed */
@Override
public SharedPreferences getSharedPreferences(File file, int mode) {
return mBase.getSharedPreferences(file, mode);
}
像@hide
一样,它导致Doclava(一个Javadoc doclet Android用于生成SDK文档和API签名文本文件)从生成的文件中省略带注释的成员文档,如果传递了 -api
标志,则来自生成的 API 签名文本文件。如果还使用 -removedApi
标志,则注释 @remove
的成员将包含在 removed.txt 签名文件中。