关于代码规范

没有规矩不成方圆,有了统一的代码规范,代码的可读性和维护性会大大提高,最直观的就体现在协同开发上,能提高不少的开发效率和少踩很多坑。
这里强烈推荐一本书《阿里巴巴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 对于根据协议合作开发的项目,必须输出最新 完整 详细的协议文档
未完待续。。。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,752评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,100评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,244评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,099评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,210评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,307评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,346评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,133评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,546评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,849评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,019评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,702评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,331评论 3 319
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,030评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,260评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,871评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,898评论 2 351

推荐阅读更多精彩内容