🎨 catch information of Error-Prone #780
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
|
补充Error-Prone使用文档 |
cyw3
reviewed
Feb 28, 2023
doc/en/guide/代码检查/工具/Error-Prone.md
Outdated
| > Error Prone是google开源的Java编译时检测工具，将常见的Java错误捕获为编译时错误，增强对java代码的类型分析，从而让开发人员及时发现问题 | ||
|
|
||
| ## TCA使用指引 | ||
| 由于Error Prone同为编译时检测工具，已添加规则至JavaWarning工具以增强类型检测。建议采用客户端本地分析模式以满足编译条件，参考[编译配置](../../../guide/分析方案/代码检查编译配置.md)，Error Prone客户端配置和编译命令可参考文档下文。 |
There was a problem hiding this comment.
这里需要详细写下：
- TCA集成方式。第一句有点表意不清，javawarning是什么？error prone跟javawarning的关系是？为什么这样集成？等问题需要解释下。
- 配置步骤尽可能详细些，比如
-
- 在规则包中增加 JavaWarning 中对应 errorp prone的规则（如何在javawarning中区分出error prone规则？）；
-
- TCA Client采用何种方式调用？需要怎么进行编译上的配置（可以跳转到下面）
-
- 启动分析，TCA Web页面上查看问题。
-
doc/zh/guide/代码检查/工具/Error-Prone.md
Outdated
| > Error Prone是google开源的Java编译时检测工具，将常见的Java错误捕获为编译时错误，增强对java代码的类型分析，从而让开发人员及时发现问题 | ||
|
|
||
| ## TCA使用指引 | ||
| 由于Error Prone同为编译时检测工具，已添加规则至JavaWarning工具以增强类型检测。建议采用客户端本地分析模式以满足编译条件，参考[编译配置](../../../guide/分析方案/代码检查编译配置.md)，Error Prone客户端配置和编译命令可参考文档下文。 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.