Java 代码风格

  • 我们使用 Java 代码风格。快速概览

    • 类名使用首字母大写驼峰命名法。

    • 方法名和变量名使用驼峰命名法。

    • 每行一个声明

      int x, y; // this is BAD!
      int a;    // split it over
      int b;    // two lines
      
  • 花括号的放置方式如下(通常,开括号在同一行,闭括号在新的一行)

    public void func(int arg) {
        if (arg != 0) {
            while (arg > 0) {
                arg--;
            }
        } else {
            arg++;
        }
    }
    
  • 我们与 Java 代码风格的不同之处

    • 类变量名称以 “m” 前缀开头(例如 mSomeClassVariable),静态变量以 “s” 前缀开头(例如 sSomeStaticVariable)

    • import 语句

      • 不要使用通配符导入,例如 `import java.util.*;`

      • 按块组织导入,块之间用空行分隔:org.mozilla.*, android.*, com.*, net.*, org.*, 然后是 java.* 这基本上是 Android Studio 默认设置,除了我们将 org.mozilla.* 放在前面 - 请相应地调整 Settings -> Editor -> Code Style -> Java -> Imports。

      • 在每个导入块中,按字母顺序排列导入名称,大写字母优先于小写字母。例如,com.example.Foocom.example.bar 之前

    • 4 个空格缩进。

    • 使用空格,而不是制表符。

    • 不要将自己限制在 80 个字符的行上。Google 的 Android 样式指南建议使用 100 个字符的行,这也是 Android Studio 中的默认设置。Java 代码在水平方向上往往很长,因此在换行时要做出适当的判断。避免在换行时出现过深的缩进。请注意,将换行部分与该行之前的某一部分对齐(而不是仅仅使用固定的缩进),可能需要在每次行更改时都移动代码,从而导致多余的空格更改。

  • 有关 Android 版 Firefox 的更多具体信息,请参阅 Android 版 Firefox 的代码风格指南

  • Android 代码风格 也有一些有用的指南。