qn_code_style.md
1.72 KB
青柠java/android代码规范
主要参见google code style 下面规定一些强制要求,其他尽量向文档靠近
- 编码utf-8
- tab 4 个空格，缩进用tab,不使用其中建议我两个
- 命名用驼峰，类名用大驼峰，方法名及成员变量等用小驼峰。尽量使用英文，不要出现拼音，除一些特殊的字段（如
qnbar,xgimi等常用名字，再如arr,dict等常用缩写）,尽量不要出现单词拼写出错的情况
- 命名时不要存在歧义，若写时想不好，一定要写好注释，方便查看及更正
- 每行不要太长，实在不可避免时在适当位置换行
- 不要出现大段空行的情况
- 花括号遵循K&R风格,空的语句块，可以在左花括号之后直接接右花括号，中间不需要空格或换行，参见
google code style
- 变量声明时每个变量占一行
- 修饰符顺序
public protected private abstract static final transient volatile synchronized native strictfp,如声明常量
private static final String NAME = "QnBar";
- 给类或方法写注释时使用
/** comment */格式，方便文档直接查看。其他注释暂不做强制要求- 资源文件命名时尽量带上前缀，例如：
activity_main.xml, Dialog命名：dialog_描述.xml例如：dialog_hint.xml, PopupWindow命名：ppw_描述.xml 例如：ppw_info.xml,列表项命名：item_描述.xml例如：item_city.xml, 包含项命名：模块(位置)描述.xml 例如：activity_main_head.xml、activity_main_bottom.xml注意：通用的包含项命名采用：项目名称缩写描述.xml 例如：xxxx_title.xml