如何在没有 R 和 BuildConfig 的情况下使用 Android Studio 创建 JavaDoc?
How to create JavaDoc using Android Studio without R and BuildConfig?
我想为我的库生成 JavaDoc,不包括 R 和 BuildConfig。 Tools
菜单中的 Generate JavaDoc...
功能没有排除文件的选项。
如何在没有 R 和 BuildConfig 的情况下使用 Android Studio 创建 JavaDoc?
如果要排除生成的文件(R、BuildConfig 等),则可以为 JavaDoc 生成指定自定义范围。要使其正常工作,您需要:
- 在左侧的项目视图中,select 生成文档的根源目录(例如 "com" 或 "org")
- 打开 JavaDoc 生成对话框(工具 -> 生成 JavaDoc...)
- Select "Custom scope"(这是我版本中的第 5 个单选按钮)和 select 您的模块(例如 "Module 'library'")
- Select 您的其他属性,例如输出目录、方法可见性等,然后单击 "OK"
就是这样。您的 JavaDocs 应该在不包含 R 或 BuildConfig 文件的情况下生成。
RocketSpock 的答案几乎已经有了,但还不完全是(截至撰写本文时)。我还不能发表评论,所以我将描述我在 Android Studio 中从我的 Android 图书馆的 Javadoc 中排除 R.java
和 BuildConfig.java
的过程1.2.2.基本上有一个非常方便的额外对话框:
打开菜单选项 Tools --> Javadoc
。
SelectCustom scope
。没有必要 select 来自
下拉菜单。
- 单击
...
图标打开 Scopes
对话框。
- 添加带有绿色
+
图标的新自定义范围。给它一个
如果您愿意,可以使用描述性名称。
- 在
Production Classes
(不是 Library Classes
,因为它们是
imports) 导航到您希望为其生成 Javadoc 的模块,
和 select 您希望包含的任何单个 Java 文件。在你的
在这种情况下,您可能想要 select 整个模块但是
手动排除 R.java
和 BuildConfig.java
。完成后,单击 OK
退出范围对话框。
- 在
Specify Generate JavaDoc scope
对话框中,如果您的新范围是
未 select 在 Custom scope
下拉菜单中编辑,现在 select 它,因为
以及任何其他附加选项,包括输出目录。
- 最后,单击
OK
生成您的 Javadoc。
接受的答案很复杂,我有一个更好的答案。
- 打开菜单选项工具 --> Javadoc。
- Select 自定义范围。然后select
Project Files
- 单击
OK
。
在这些之后,您将看到 R 文件和 BuildConfig 被排除在外。
另一种方法是
1- 转到工具 --> 生成 JavaDoc...
2- select 自定义范围
3- 从下拉菜单 select 打开文件。
此方法将仅为您 window
中打开的文件生成文档
我想为我的库生成 JavaDoc,不包括 R 和 BuildConfig。 Tools
菜单中的 Generate JavaDoc...
功能没有排除文件的选项。
如何在没有 R 和 BuildConfig 的情况下使用 Android Studio 创建 JavaDoc?
如果要排除生成的文件(R、BuildConfig 等),则可以为 JavaDoc 生成指定自定义范围。要使其正常工作,您需要:
- 在左侧的项目视图中,select 生成文档的根源目录(例如 "com" 或 "org")
- 打开 JavaDoc 生成对话框(工具 -> 生成 JavaDoc...)
- Select "Custom scope"(这是我版本中的第 5 个单选按钮)和 select 您的模块(例如 "Module 'library'")
- Select 您的其他属性,例如输出目录、方法可见性等,然后单击 "OK"
就是这样。您的 JavaDocs 应该在不包含 R 或 BuildConfig 文件的情况下生成。
RocketSpock 的答案几乎已经有了,但还不完全是(截至撰写本文时)。我还不能发表评论,所以我将描述我在 Android Studio 中从我的 Android 图书馆的 Javadoc 中排除 R.java
和 BuildConfig.java
的过程1.2.2.基本上有一个非常方便的额外对话框:
打开菜单选项
Tools --> Javadoc
。Select
Custom scope
。没有必要 select 来自 下拉菜单。- 单击
...
图标打开Scopes
对话框。 - 添加带有绿色
+
图标的新自定义范围。给它一个 如果您愿意,可以使用描述性名称。 - 在
Production Classes
(不是Library Classes
,因为它们是 imports) 导航到您希望为其生成 Javadoc 的模块, 和 select 您希望包含的任何单个 Java 文件。在你的 在这种情况下,您可能想要 select 整个模块但是 手动排除R.java
和BuildConfig.java
。完成后,单击OK
退出范围对话框。 - 在
Specify Generate JavaDoc scope
对话框中,如果您的新范围是 未 select 在Custom scope
下拉菜单中编辑,现在 select 它,因为 以及任何其他附加选项,包括输出目录。 - 最后,单击
OK
生成您的 Javadoc。
接受的答案很复杂,我有一个更好的答案。
- 打开菜单选项工具 --> Javadoc。
- Select 自定义范围。然后select
Project Files
- 单击
OK
。
在这些之后,您将看到 R 文件和 BuildConfig 被排除在外。
另一种方法是 1- 转到工具 --> 生成 JavaDoc... 2- select 自定义范围 3- 从下拉菜单 select 打开文件。
此方法将仅为您 window
中打开的文件生成文档