java 个人编码规则

Posted 2022-12-13 Welljia

Coding Rule

• 一个文件应只包含一个类或者接口，如果存在私有类或者接口，应放在主类或接口后面

• 不能有重复代码，重复代码应封装成函数，或者放到基类里面

• 统一采用4个空格缩进，务必将代码编辑软件的tab设置为以4个空格替代

• 类的开始是变量定义，函数声明放后面

• 相关的函数应该放在一起，调用者在被调用者上面

• 变量定义应靠近使用它的地方

• 类名应该是名字或名称短语，不能是动词，比如Customer, WikiPage

• 方法名应该是动词或动词短语，比如save, deletePage

• 函数与变量的第一个词全小写，后面的词第一个字母大写

• 用代码来注释，让函数或变量的名字就是注释，startActivityForResult

• 一切变量定义时必须初始化

• 每一行只申明一个变量

• 函数名与参数列表”(”之间不要用空格

• 类与函数定义起始的”“应该与名字放在同一行

• 类与函数的””应独立为一行，除非是空函数

• 每一行只做一次运算，++I = j++

• 不要使用”,”表达符在同一行做多件事

• 该用括号就要用括号if ((a==b) && (c==d))

• 正确的使用空格

• 调用有错误值的函数，特别是系统函数，务必进行返回值判断，并且要打印出error code

• 尽量的不要返回null，也不要传递null，否则代码到处都要进行null判断

• 对于可能为空的引用，务必进行非空判断

• 显示的表明自己会抛出异常

• ​

  ​