在python实际开发中,通过适当添加空行能使代码的布局更为优雅、合理
布局清晰、整洁、优雅的代码能够给阅读它的人带来愉悦感,
为了让读者更加深入地理解代码布局的重要性,我做了一个实例
下面两段代码,编码完全相同,只是在排版上做了一定修改,你觉得哪个更加容易阅读呢?
看了上面两个例子,相信很多读者都倾向于阅读第一个例子,这就是代码布局和排版带给我们的最直观的感受。
和其他语言一样,Python代码布局也有一些基本规则可以遵循。
(1)在一组代码表达完一个完整的思路之后,应该用空白行进行间隔。
但读者需要注意的是:空行是在不隔断代码之间内在联系的基础上插入的,
也就是说有关联的代码还是需要保持紧凑、连续。就像下面的代码:
(2)尽量保持上下文语义的易理解性。
如当一个函数需要调用另一个函数的时候,尽量 将它们放在一起,最好调用者在上,被调用者在下。例如下面的代码:
(3)避免过长的代码行,每行最好不要超过80个字符。
以每屏能够显示完整代码而不需要拖动滚动条为最佳
超过的部分可以用圆括号、方括号和花括号等进行行连接,并且保持行连接的元素垂直对齐。例如下面的代码:
(4)不要为了保持水平对齐而使用多余的空格
其实使阅读者尽可能容易地理解代码所要表达的意义更重要。
如下列代码的主要目的是赋值,为了可以保持对齐往往会造成“喧宾夺主”。
同时也不要在一行有多个命令,如不要将X=1;Y=2;直接写在一行中。
(5)空格的使用要能够在需要强调的时候警示读者,在疏松关系的实体间起到分隔作用,
而在具有紧密关系的时候不要使用空格。具体细节如下: