所信奉的编程哲学
陆陆续续看完了《代码大全》、《重构》、《代码整洁之道》、《程序员修炼之道》以及《The Art of Readable Code》,获益匪浅。下面就分享几条我赞同并信奉的编程哲学,顺便废话几句。
本文适合有一定编程经验的读者阅读,高手请轻喷:)
?
代码是写给人看的(Coding for Reading)?
请先思考,评价一段代码优劣最重要的标准是什么?
有个著名的图,相信大家都见过,讲的是Code Review时被骂WTF的次数越少,代码的质量就越高。这虽然有点无厘头,但是却不无道理。
《The Art of Readable Code》中告诉我们,评价一段代码的质量的最佳标准是可读性,即别人理解代码意图所需要的时间。
可读性有什么用,我写出一段代码,能完成目标,能通过测试不就行了吗?
不管你是团队开发,还是一个人单干,只要项目还在运作,代码总是要有人来维护的。如果有一天你不在或者离开了,别人应该能很轻松的看懂你的代码,而不是猜来猜去,最后还要来问你,甚至弃用整段代码重新再写。作为一个负责任的开发者,应该尊重自己的劳动成果,也尊重别人的时间。
当你写下一段代码时,脑子里有清晰的逻辑(比如这里必须这么做,因为……这里不能那么做,因为……)。而别人看这段代码时,脑中是一片空白(这个变量是干什么的?为什么要多加一层判断?这个数为什么是 2 不是 3 ?),除非能完整复现你当时脑中的逻辑,否则就不能理解这段代码。
所以我们应该做的是,把写代码时脑中想到的逻辑的每一个细节,尽可能地写到代码以及注释中,从而帮助后来的阅读者快速复原整个逻辑。简单来说可以有以下的方法:
用常量代替魔术数在一段代码中出现 if ( level > 3 ) ...的时候,也许你会想:为什么是 3 不是 4 呢?这就是所谓的魔术数。通过上下文也许你可以判断出这个 3 是指最高等级,但是可能这段代码中 3 出现了好几次。你会迷惑:它们是不是都是一个意思?当我要把最高等级改成 4 的时候,是不是应该修改所有的 3 ?
如果代码的作者定义一个常量MAX_LEVEL = 3,同时还有一个常量USERS_PER_PAGE = 3,并在不同的地方使用不同的常量,就不会有这样的混淆了。
使用富含信息的类名、变量名和函数名?countPlusOne();...countPlusOne();...function countPlusOne() { $('#count').text( + $('#count').text() + 1 ); //以后修改只用改这里就好了}
如果有几段代码很相似,往往可以提取其共性逻辑,使用不同的调用参数进行区分。
countChange( +1 );...countChange( -1 );...function countChange( change ) { $('#count').text( + $('#count').text() + change ); }?用循环减少重复?
$item[ 'id' ] = $_POST[ 'id' ];$item[ 'name' ] = $_POST[ 'name' ];$item[ 'mail' ] = $_POST[ 'mail' ];$item[ 'qq' ] = $_POST[ 'qq' ];
?如果有大块逻辑雷同只有一两个地方更改的代码,往往可以用循环来解决:
foreach ( array( 'id', 'name', 'mail', 'qq' ) as $key ) { $item[ $key ] = $_POST[ $key ];}