目录:
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】错误,不能工作:(标记人,标记时间,[预计处理时间])