ocliint-选择正确的报告

选择正确的报告¶

oclint 支持多种报告类型，可以根据不同的需求选择不同的报告类型。所有的报告类型都在 oclint-reporters模块。

  报告选项¶

如果需要其他报告类型需添加 命令  -report-type <report name> 。默认oclint 使用的是Text类型，所以  -report-type text  命令一般是不需要特意加上的。

有些报告类型是不适合在控制台查看的，例如html报告，PMD报告。这时候可以选择添加 -o <path>  选项指定报告生成的位置。

结合这两个字选项，例如，输出HTML格式的oclint_result.html、文件 可以通过以下命令实现。

oclint -report-type html -o oclint_result.html <sources> -- <compiler flags>

报告类型¶

下面可同选择的报告类型。在括号中的名称是用于report-type选项的值。

纯文本报告（text）¶

纯文本报告的目的是直接输出结果到控制台。

报告首先检查的总结，它包括总的文件，文件的侵犯数量，违反了三个不同优先级的数数。

每种违规的输出格式，类似于编译器错误。报告中的每一行代表一个违规。它开始与文件名，行，并且该冲突发生的源代码的列。违反的规则的名称后打印，其次是规则的优先级。OCLint还输出的描述，如果目前的冲突有什么。

示例文本报告

HTML报告（html）¶

HTML报告在浏览器提供更好的可读性。并对不同的级别提供了不同的加亮。

样本HTML报告

XML报告（xml）¶

示例XML报告

JSON报告（json）¶

样品JSON报告

PMD记者（pmd）¶

由于PMD报告由需对java开发的持续集成（CI）项目支持，Oclint也支持xml格式的PMD报告哦啊。可以更方便的持续集成。

示例PMD报告

记者的Xcode（xcode）¶

Xcode报告用于Xcode IDE内部使用

配置文件¶

可以用配置文件方式给团队提供统一报告。提供一个到.oclint文件，例如，配置HTML报告可以配置为：

report-type: html
output: oclint.html