qishi821的个人博客分享 http://blog.sciencenet.cn/u/qishi821

博文

代码整洁之道

已有 1848 次阅读 2017-5-12 21:46 |个人分类:软件工程|系统分类:科研笔记|关键词:代码整洁之道| 代码整洁之道

以下是《代码整洁之道》这本书中一些,摘抄在此,方便自己,也希望能够帮助他人!顺便说句题外话,其实,这本书写的很不错,这也是华为的高级工程师极力推荐的。

1.关于实体变量应该放在哪里,争论不断。在C++中,通常会采用所谓“剪刀原则",所有实体变量都放在底部。而在Java中,惯例是放在类的顶部。没理由去遵循其他惯例。重点是在谁都知道的地方声明实体变量。大家都应该知道在哪能看到这些声明。


2.相关函数。若某个函数调用了另外一个,就应该把他们放在一起,而且调用者应该尽可能放在被调用者上面。这样,程序就有个自然的顺序。若坚定地遵循这条约定,读者就能够确信函数声明总会在其调用后会很快出现。这样就能轻易找到被调用的函数,极大地增加了整个模块的可读性。


3.变量声明。变量声明应尽可能靠近其使用位置。


4.概念相关。概念相关的代码应该放到一起。相关性越强,彼此之间的距离就该越短。如上所述,相关性应建立在直接依赖的基础上,如函数间调用,或函数使用某个变量。但也有其他相关性的可能。相关性可能来自于执行相似操作的一组函数。


5.横向格式。一行代码有多宽?我一向遵循无需拖动滚动条到右边的原则。但今年来显示器越来越宽,而年轻程序员又能将显示字符缩小到如此程度,屏幕上甚至能容纳200个字符的宽度。别那么做。我个人的上限是120个字符。


6.水平方向上的区隔与靠近。我在赋值操作符周围加上空格字符,以此达到强调的目的。赋值语句有两个确定而重要的要素:左边和右边。空格字符加强了分割效果。另一方面,我不在函数名和左圆括号之家加空格。这是因为函数与其参数密切相关,如果隔开,就会显得互无关系。我把函数调用括号中的参数一一隔开,强调逗号,表示参数是相互分离的。乘法因子之间没有空格,因为他们具有较高优先级加减法运算项之间用空格隔开,因为加减法优先级较低




http://blog.sciencenet.cn/blog-2355761-1054621.html

上一篇:在VMware中不同的操作系统之间使用ping命令
下一篇:SDN-1

0

该博文允许注册用户评论 请点击登录 评论 (0 个评论)

数据加载中...
扫一扫,分享此博文

Archiver|手机版|科学网 ( 京ICP备14006957 )

GMT+8, 2019-9-23 15:10

Powered by ScienceNet.cn

Copyright © 2007- 中国科学报社

返回顶部