关于代码规范

没有规矩不成方圆，有了统一的代码规范，代码的可读性和维护性会大大提高，最直观的就体现在协同开发上，能提高不少的开发效率和少踩很多坑。
这里强烈推荐一本书《阿里巴巴Java开发手册》，理由有下

• 《阿里巴巴Java开发手册》是阿里内部Java工程师所遵循的开发规范，涵盖编程规约、单元测试规约、异常日志规约、MySQL规约、工程规约、安全规约等，这是近万名阿里Java技术精英的经验总结，并经历了多次大规模一线实战检验及完善。这是阿里回馈给Java社区的一份礼物，希望能够帮助企业开发团队在Java开发上更高效、容错、有协作性，提高代码质量，降低项目维护成本。
• 手册配套插件已有数百万开发工程师下载，数以千计企业在内部推行
• 首款中国人自己的开发规范

因为我已提前阅读了这本手册且对自己要求严格按照规范书写代码，在这过程中也有了一些自己的见解和总结，结合咱们目前实际情况，我认为有如下几点是必须遵守的
IDE File Encoding 数据库编码方式 工作空间等确保统一设置为UTF-8

1. 比较重要的规范

   1.1 方法名 参数名 局部变量 成员变量必须遵循驼峰风格，首字母小写，尽量不用缩写
   反例（比较容易犯的）

// 首字母大写
String HelloWrold;
// 变量没有遵循驼峰风格
long available_Max_Time
// 避免纯拼音 除非国际通用
int  shijian
// 不能以下划线或美元符开始或结束
int _name / $name / name_
// 拼音英语混用
int addFenshuToCourse
// 

1.2 常量名全部大写，单词间用下画线隔开，力求语言表达完整清楚，不要嫌名字长
正例

int SET_TIME_PERIOD_REQUEST_CODE = 9;
int SET_TIME_AVAILABLE_REQUEST_CODE = 10;

1.3 不允许任何魔法值，就是未经预先定义的常量（这个是我们高频出现的）
反例

String key = "Id#elite_" + orderId;
if (SystemProperties.getBoolean("ro.xxx.xxxx", false)

1.4 if / for / while / switch / do保留字与括号之间都必须加空格
正例

if (isSuccess) {
  for (String time : times) {
  
  }
}

1.5 任何二目 三目运算符左右两边都需要加一个空格
正例

int count = 0;
if (count == MAX_LENGTH_OF_RULE) {
 
}

1.6 注释的双斜线与注释内容之间有且仅有一个空格
正例

// 这是一条注释
String birthday;

1.7 方法参数传入和定义时，多个参数后边必须有空格
正例

subtract(one, two, three);

1.8 避免过多的if else if else，阅读起来累得很，可以考虑用卫语句或策略模式实现
正例

// 卫语句实现
    if (isOneDayPass()) {
            resetCalculationTime();
            Log.d(TAG, "rest total time as : " + totalUsedTime);
        }
        if (!timeLockIsEnable()) {
            Log.d(TAG, "time lock is unable");
            return;
        }
        if (isDialogShowing()) {
            return;
    }

1.9 工程或模块共用的常量，用对应的常量类去维护，建议不同模块不同常量类
1.10 对于一个对象多个创建方法时，推荐使用工厂方法模式创建对象
1.11 对于逻辑较复杂的方法，必须在方法签名上写名注释，包括功能参数返回等说明
1.12 所有抽象方法，包括接口中的方法 必须用Javadoc 注释
1.13 无用代码请删除，谨慎注释代码，未完成的功能请用// TODO备注说明
1.14 请尽量尝试以高内聚 低耦合的思想去进行封装和解耦，对于我们这种需求一天一样的项目来说能提高很多工作效率
1.15 对于根据协议合作开发的项目，必须输出最新 完整 详细的协议文档
未完待续。。。