2018-08-08 - Java代码规范

目录:
1、字符串
2、注释规约

进击的小仙

一、字符串

1.1、字符串一定要放在strings.xml里面,不要直接用
1.2、字符串占位符的使用:占位符使用详解

三种占位符格式:

  • %n$ms : 输出的是字符串,n代表是第几个参数,设置m的值可以在输出之前放置空格
  • %n$md: 输出的是整数,n代表是第几个参数,设置m的值可以在输出之前放置空格,也可以设为0m,在输出之前放置m个0
  • %n$mf:输出的是浮点数,n代表是第几个参数,设置m的值可以控制小数位数,如m=2.2时,输出格式为00.00
<string name="voice_hearer_init_error">
        语音监听 初始化失败,错误码:<xliff:g id="error_code">%1$d</xliff:g>
        
String toastContent = activity.getResources().getString(R.string.voice_hearer_init_error,code);

二、注释规约

2.1、类注释

所有的类都必须添加创建者和创建日期

2.2、使用Javadoc注释类、类属性、类方法

类、类属性、类方法的注释必须使用 Javadoc 规范,使用【/**内容**/】格式,不能使用【//内容】

2.3、抽象方法必须用Javadoc注释

所有的抽象方法(包括接口中的方法)必须要用 Javadoc 注释,除了返回值、参数、 异常说明外,【对子类的实现要求,或者调用注意事项,也要一并说明】

2.4、单行注释用// ,多行注释用/* */

方法内部注释,单行注释用【//】,多行注释用【/*内容 */】,注意对齐

2.5、枚举每个数据项要注释

所有的枚举类型都要注释,说明每个数据项的用途

2.6、注释注意中英文

不要用半吊子英文注释,关键词和专有名词可保持英文

2.7、❗️代码修改与对应注释要同步

代码修改后,要同步修改注释。尤其是参数、返回值、异常、核心逻辑等等

2.8、谨慎注释掉代码。

注释掉的代码要注释说明。没用就果断删掉。

2.9、注释的要求
  • 9.1、能够准确反应设计思想和代码逻辑;
  • 9.2、能够描述业务含义
2.10、让代码自解释,注释太多是负担

尽量做到让代码自解释,注释太多也是一种负担。注释要求精简准确、表达到位。

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