您的位置:首页 > 其它

1、简明、清晰的展示

2016-04-06 12:19 316 查看
1、关于命名
总纲: 选择专业的词、避免泛泛而谈的词、用具体的名次来代替抽象的名词、 使用前缀或者后缀来附带信息(比如heght_m,高度以米来度量)、决定名字长度、 利用名字格式来表达含义
选择专业的词:比如常用的getPages()就不如用FetchPages()或者DownLoadPages()好,int size 就没有int heght好。 在循环迭代中,可以使用默认的i、j、k,但是最好也给予一些附加信息比如parentIndex
做有意义的区分
每个概念对应一个词
添加有意义的语境,比如addCirculSize()
类名:类名和对象名应该是名词或者名词短语,如Customer、WikiPage、Account, 避免Manager、Processor这样的类名。类名不能是动词。
方法名:应当是动词或者动词短语,如postPayment、deletePage或者save。属性 访问器、修改器和断言应该根据其值命名,并依照JavaBean标准加上get、set、is前缀。 重载构造器时,使用描述了参数的静态工厂方法名。例如: Complex fulcreumPoint = Complex.FromRealNumber(12.0); 通常好于:Complex fulcrumPoint = new Complex(23.0);
2、关于函数
使用描述性的名称,比如: 用具体的词来代替抽象的词:比如height,这个是什么的height? 为什么不用buildHeigh呢?明显就知道是建筑的高。 使用不会误解的名称,这种情况可以多问自己:用这个名字是否会让我想起另一个意思? 推荐用min和max来表示极限 推荐用first和last来表示包含的范围或者用begin和end 给布尔值命名可以加上:is、has、can、should等,结果默认为true。
函数应当短小,并尽量保证一个函数只做一件事,没有副作用。 判断:是否在该函数名下统一抽象层上。自顶向下读代码:向下规则。
函数的参数:最理想为0、其次是一,再次是二,尽量避免3,多于3个开始构建参数对象。
分隔指令与询问:将条件判断语句封装为有可读性名称的函数。
switch语句:使用多态来解决,继承、或者state、category
使用异常代替返回错误码,抽离Try/Catch代码块
如何写出这类函数
3、关于注释
不给不好的命名加注释,这说明你需要给命名了。 特定的常量需要注释,全局性注释,总结性注释, 有输入输出或者格式转换需要注释:例如:将aaaaabbbbb转为ab的格式, 需要声明代码意图、嵌入的注释需要在参数之前。
应该去掉下列注释: 误导性注释 注释掉的代码
4、关于间距
使代码看上去整体很有美感、有结构感。 可以从一下几点处理:使用一致的布局、 让相似的代码看上去相似、把相关的代码 进行分组,形成代码块。
垂直格式
被调用函数应该紧跟代码调用的函数
水平格式
5、关于错误
1、使用异常而非返回码
2、使用不可控异常
3、给出异常发生的环境说明
4、定义常规流程,然后编写异常
5、别返回Null值、别传递null值。空对象方式
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: