目录 start
目录 end
|2018-04-08| 码云 | CSDN | OSChina
《代码整洁之道》
命名
- 有意义,短而精悍
- 类用名词,方法用动词,还要特别注意语境
- 普通变量:首单词小写,其后使用驼峰法命名
- 常量:全部大写
- 命名有意义,简单直接明了就不需要注释了
函数
- 短小,只做一件事,if while for try catch中只写一句话(调用一个函数),并且减少嵌套
- 如果非要用 switch 语句就要尽量简化他
- 函数参数越少越好,最好没有
- 函数参数最好不要使用输出类型
- 分隔指令(动作,会改变数据)与查询(只做一件事)
- 使用异常代替返回特定的错误码
- 把try catch 抽离封装到函数内
- 避免重复
注释
- 注释越少越好,注释往往得不到维护,代码变动了,注释却没有变,这时候的注释就是错误的引导了(坏注释)
- 注释都是程序猿的自言自语,不要说废话
- 避免 坏注释,多余的注释
格式
- 赋值,一般的类、方法的缩进格式我已经了解
- 注意:函数的参数,最好是这种格式 fun(int a, int b, ){} 逗号后要加空格
- 一行字符在20-120之间,不过我一般是达到不使用滑动条看代码即可
- 函数的排布,最好是越底层越在下面的行数上
异常
- 避免null:避免函数返回值是null以及函数入参是null
- 尽量避免可控异常(throws)的出现,因为破坏了封装