在哪里放置代码约定规则?

时间:2013-02-18 20:45:50

标签: java android coding-style

我正在与一组开发人员(位于同一地点)开展项目(Android项目)。

我们需要为命名类,文件,xml元素等设置一些规则......

目前,我们在项目的根目录中有一个名为“code_conventions.txt”的文件,我们以自由文本的方式编写规则。

例如: 1. Append "Activity" string after each class in the app that extends Activity Class

最好的方法是什么?

3 个答案:

答案 0 :(得分:2)

我所在的公司拥有一套用于所有Java开发的编码标准。该文件托管在我们自己的wiki Intranet上。新用户必须阅读该文件并遵循约定集。该文件包含诸如使用m作为成员变量名前缀的约定,例如。 mUsername,或使用camel case作为类和方法名称。

答案 1 :(得分:1)

这些规则适用于自动化。查看Checkstyle,它会在您编码时自动检查这些类型规则的执行情况,因此无需进行人工检查。

例如,您可以使用正则表达式检查来验证您在问题中记下的断言。

答案 2 :(得分:1)

如果您真的想要强制执行编码约定,可以使用http://checkstyle.sourceforge.net/来查看构建的那部分。