原文:

http://www.oschina.net/translate/basic-rules-for-code-readability-and-the-if-statement


代码应该是可阅读就像你的自然语言一样。我将从一个有趣的条件语句开始。

if ( !notOk != false ) {
userObj.ask();
}

这样的表达式有点混乱,你永远不会使用自然语言构建这样的表达式。通过几个步骤,这个问题可以很简单解决:

( !notOk != false )
( !notOk == true )
( !notOk)

现在你应该重新想一个变量名啦:

isOk = !notOk

这个结果更适合阅读:

if ( isOk ) {
userObj.ask();
}

if – if – if 层级树

删除一些注释和其他一些代码行后, 这是另一个典型的编码风格:

if ( A ) {
if ( !B ) {
if ( C ) {
f();
}
}
}

一些聪明的程序员有较短的变体看起来像这一行:

if ( A ) if ( !B ) if ( C ) { f(); }

但使用逻辑运算符使代码更加可读的:

if ( A && !B && C ) { f(); }

如果你使用一些If层级语句重构一个函数, 可以尝试使用逻辑运算符来代替if层级树。但它应该有像自然语言一样的可读性。


小心而使用与(&)和或比较整数! 单个 & 在多数编程语言里是按位与(AND)操作符。

请看下面的例子:

ANSI-C:
1 & 2 = 0
1 && 2 = 1 // true, 并且true 等于1 JavaScript:
1 & 2 = 0
1 && 2 = 2 // 第一个为 true, 所以返回第二个 python:
1 & 2 = 0
1 and 2 = 2 # 类似 JavaScript 的变体 Java:
1 & 2 = 0
1 && 2 // 使用int值不合法

if – true – false 赋值函数
function isNameSet(name) {
if (name===null || name==="") {
return false;
} else {
return true;
}

有时这种结构隐藏在多行代码里面, 其它一些语言也可以找到类似的结构。 但下面这个简单的形式是更优雅的解决方案, 也很好理解:

function isNameSet(name) {
return !(name==null || name=="");
}

但你只想看看名字的值是否已经声明。 很多语言,例如 Javascript (阅读  Matthias Reuter 写的  all about types)能将值直接转换为真值(阅读  Douglas Crockford 写的  The Elements of JavaScript Style )。
function isNameSet(name) {
return name;
}

在代码简无可减后,在判断中直接使用字符串值。

if (!name) {
name = window.prompt("What’s your name?");
}

使用三元运算符(小心)
function genderStr(gender) {
if ( gender == "m" ) {
return "male";
} else {
return "female";
}
}

程序也可以总结为:

function trueFalseStr(cond, trueStr, falseStr) {
if (cond) {
return trueStr;
} else {
return falseStr;
}
}

或者你可以使用三元运算符(很多语言都有提供):

return (gender == "m")? "male" : "female"

对于 python(v2.5版本之后)可以用下面的语法替代 '?'运算符:

return "male" if gender == "m" else "female"

另一个可用的变体同样可读性很高:

return (gender=="m") and "male" or "female"

yoda 条件

我提供一篇旧文章帮助你理解什么是 yoda conditions. 下面的例子显示它们的不同之处:

if (value = 42) {
...
}

为了防止条件式赋值,通常把常量写在前面(这样会得到一个编译时警告):

if (42 = value) {
...
}

在 yoda conditions 里, 我不得不收回关于代码可读性的建议。


利用if语句映射值

我在 stackoverflow.com 看到一篇好文:

function norm(v) {
size = 7;
if ( v > 10 ) size = 6;
if ( v > 22 ) size = 5;
if ( v > 51 ) size = 4;
if ( v > 68 ) size = 3;
if ( v > 117 ) size = 2;
if ( v > 145 ) size = 1;
return size;
}

其中有很多变体,下面这个以 Javascript 用三元操作符编写的程序可读性很差:

function norm(v) {
return return v > 145 ? 1 : v > 117 ? 2 : v > 68 ? 3 : v > 51 ? 4 : v > 22 ? 5 : v > 10 ? 6 : 7;
}

下面这个 ANSI C 编写的计算。只有当值能够转换为布尔量时才能运行。

int norm(int x){
return 7 - (x>10) - (x>22) - (x>51) - (x>68) - (x>117) - (x>145);
}

If语句能够使的条件限定更加可读(python):

def norm(v):
if v< 11: size=7
elif v< 23: size=6
elif v< 52: size=5
elif v< 69: size=4
elif v

且现在变体可以写成 list 形式的(好吧,虽然可读性没有变好,但是很好玩):

def norm(v):
return 1+len([x for x in [11, 23, 52, 69, 118, 146] if v

编程规范之 if 语句的简单规则的更多相关文章

  1. JAVA 编程规范

       软件开发技术规范 PTHINK-DEVELOP-JAVA-091010         Java语言编程规范   2009-10-10发布                2009-10-11实施 ...

  2. 《C+编程规范 101条规则、准则与最佳实践》笔记

    <C+编程规范 101条规则.准则与最佳实践> 0.不要拘泥于小节(了解哪些东西不应该标准化) * 与组织内现有编码规范一致即可 * 包括但不限于: - 缩进 - 行长度 - 命名规范 - ...

  3. Java编程规范(命名规则)

    1.目的 编程规范是对编程的一种约定,主要作用是增强代码的可读性和可维护性,便于代码重用. 2.命名规则 首先要求程序中的各个要素都遵守命名规则,然后在编码中严格按照编码格式编写代码.命名规则包括以下 ...

  4. Fortify规则与CERT JAVA 安全编程规范的对照表

    Fortify规则与CERT JAVA 安全编程规范的对照表http://www.automationqa.com/forum.php?mod=viewthread&tid=4353& ...

  5. JAVA 编程规范(上)

    2016-03-20 J120-CHARLIEPAN JAVA 编程规范(上) 1.      应用范围 本规范应用于采用J2EE规范的项目中,所有项目中的JAVA代码(含JSP,SERVLET,JA ...

  6. Python编程规范(PEP8)

    Python编程规范(PEP8) 代码布局 缩进 对于每一次缩进使用4个空格.使用括号.中括号.大括号进行垂直对齐,或者缩进对齐. 制表符还是空格? 永远不要将制表符与空格混合使用.Python最常用 ...

  7. Python 编程规范-----转载

    Python编程规范及性能优化 Ptyhon编程规范 编码 所有的 Python 脚本文件都应在文件头标上 # -*- coding:utf-8 -*- .设置编辑器,默认保存为 utf-8 格式. ...

  8. 华为C语言编程规范

    DKBA华为技术有限公司内部技术规范DKBA 2826-2011.5C语言编程规范2011年5月9日发布 2011年5月9日实施华为技术有限公司Huawei Technologies Co., Ltd ...

  9. 中兴软件编程规范C/C++

    Q/ZX 深圳市中兴通讯股份有限公司企业标准 (设计技术标准) Q/ZX 04.302.1–2003      软件编程规范C/C++                               20 ...

随机推荐

  1. H - Pots

    题目大意: 有一个瓶子A和一个瓶子B,可以有三种操作倒满,倒空,或者把瓶子A倒向瓶子B(或者把瓶子B倒向瓶子A),可以扩展出6种操作,没什么简单的写法,只能一种一种的写..... 当然是使用广搜... ...

  2. CentOS7 盒盖休眠

    https://wiki.archlinux.org/index.php/Power_management_(%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87) CentOS ...

  3. Linq to sql并发与事务

    本文转载:http://www.cnblogs.com/lovecherry/archive/2007/08/20/862365.html 检测并发 首先使用下面的SQL语句查询数据库的产品表: se ...

  4. [Angular 2] Template property syntax

    This lesson covers using the [input] syntax to change an element property such as “hidden” or “conte ...

  5. cocos2d-x项目过程记录(Objective-C转C++)

    (原创作品,欢迎转载,注明出处,谢谢:http://www.cnblogs.com/binxindoudou/admin/EditPosts.aspx?postid=3179335) 1.单例模式中, ...

  6. Eclipse中使用git把项目导入到osc@git中

    方便Eclipse用户使用Git把项目导入到osc@git中进行管理. Eclipse Git osc@git 一.原有项目:  项目名为TestGit 二.在osc@git上面创建一个新项目库. 填 ...

  7. ORACLE 数据库总结

    1.表和数据恢复 1.从回收站里查询被删除的表 select object_name,original_name,partition_name,type,ts_name,createtime,drop ...

  8. Rational rose下载,安装,破解

    rationalrose是一个镜像文件,后缀名是bin 之前尝试过用虚拟光驱来打开,不知道为什么,在win10的环境下,虚拟光驱硬是不能加载bin文件,后来拷到虚拟机上,打开了bin镜像文件,得到了一 ...

  9. 一段jquery代码,保存

    @CHARSET "UTF-8"; #table_id tbody tr.odd td:hover{ background-color:#93CFE5; } #table_id t ...

  10. tinkphp URL重写,支持伪静态

    通常的URL里面含有index.php,为了达到更好的SEO效果可能需要去掉URL里面的index.php ,通过URL重写的方式可以达到这种效果,通常需要服务器开启URL_REWRITE模块才能支持 ...