在Android Studio或git / github中跨团队实施编码风格并提供警告和无尘

时间:2015-02-06 22:29:59

标签: android git github android-studio

我希望以一种确保编码风格以及警告和无棉花强制执行签名的方式设置我们的项目。我还希望让开发人员能够非常轻松地查看他们何时不合规。

理想情况下,当您编辑文件或运行构建时,这将在Android Studio中显示(我们所有的开发人员都使用相同的IDE)。此外,如果有这样的执法,那就太好了#34;只是工作"当开发人员克隆回购时,而不需要任何额外的手动设置。

最干净的方法是什么?

1 个答案:

答案 0 :(得分:6)

CheckstyleFindBugsPMD等静态代码分析器可以为您提供帮助。
它们可以配置为在these scripts的帮助下与Gradle和Android Studio一起使用。如果根据分析仪的话有些错误'配置构建将失败。

由于这些scrips与Gradle集成在一起,因此可以提交repo并在开发人员克隆它时工作。

不幸的是,生成的报告未与Android Studio集成,因此使用gradle包装器从控制台构建和运行检查的更好方法。静态分析仪'任务被配置为依赖于check任务,因此./gradlew check命令将全部运行它们。

报告位于$project.buildDir/reports目录中,但也可以更改。

Checkstyle配置非常灵活。它们可以配置为您喜欢的任何代码样式。例如,Google Java Code Checkstyle config

PMD具有对您的代码运行检查的规则集。它还有android rules。这是一本指南how to make a ruleset configuration for PMD

FindBugs可帮助您找到Java代码中的常见错误。例如。它使用+检测多个字符串连接,并建议使用StringBuilder。它可以配置filter files

也不要像这样完全关闭lint检查:

lintOptions {
    abortOnError false
}

更好的方法是禁用特定检查,如果您不喜欢它们,例如:

lintOptions {
    disable 'InvalidPackage'
}