如何在没有R和BuildConfig的情况下使用Android Studio创建JavaDoc？

Question

我想为我的库生成JavaDoc,不包括R和BuildConfig.菜单中的Generate JavaDoc...功能Tools无法排除文件.

如何在没有R和BuildConfig的情况下使用Android Studio创建JavaDoc？

Answer 1

RocketSpock的答案几乎就在那里,但并不完全(截至本文撰写时).我还不能发表评论,所以我将描述我过去排除的过程R.java以及BuildConfig.javaAndroid Studio 1.2.2中我的Android库的Javadoc.基本上有一个非常方便的额外对话框:

1. 打开菜单选项Tools --> Javadoc.

2. 选择Custom scope.没有必要从下拉菜单中选择任何内容.

3. 单击...图标以打开Scopes对话框.
4. 使用绿色+图标添加新的自定义范围.如果您愿意,请给它一个描述性的名称.
5. 在Production Classes(不是Library Classes,因为那些是导入)导航到您希望为其生成Javadoc的模块,并选择您希望包含的任何单个Java文件.在您的情况下,您可能希望选择整个模块,但手动排除R.java和BuildConfig.java.完成后,单击OK以退出"范围"对话框.
6. 在Specify Generate JavaDoc scope对话框中,如果未在Custom scope下拉菜单中选择新范围,请立即选择它,以及包括输出目录在内的任何其他选项.
7. 最后,单击OK以生成您的Javadoc.

Answer 2

接受的答案非常复杂,我有一个更好的答案.

1. 打开菜单选项工具 - > Javadoc.
2. 选择自定义范围.然后选择Project Files
3. 点击OK.

在这些之后,您将看到R文件和BuildConfig被排除在外.

Answer 3

如果要排除生成的文件（R，BuildConfig等），则可以为JavaDoc生成指定自定义范围。为了使其正常工作，您将需要：

1. 在左侧的“项目”视图中，选择根源目录以为其生成文档（例如“ com”或“ org”）
2. 打开JavaDoc生成对话框（工具->生成JavaDoc ...）
3. 选择“自定义范围”（这是我的版本中的第5个单选按钮），然后选择您的模块（例如“模块'库'”）
4. 选择其他属性，例如输出目录，方法可见性等，然后单击“确定”

而已。您的JavaDocs应该在不包含R或BuildConfig文件的情况下生成。