python代码格式-pyhon代码设计格式指南
⼀ 缘由:
经常看到周围⼈写的代码,在⼤公司有规范,很多⼈不乱写代码,但是在很多⼩公司,很多程序员都是半路出家,也不喜欢读书学习,导致写出来的代码乱七⼋糟。今天拜读了python编程这本书,作者把python语⾔的编程规范给列出来了,感觉这块⾮常好,就给⼤家分享⼀下了。
⼆ python代码格式设置指南:
python新手代码示例若要提出Python语⾔修改建议,需要编写Python改进提案 (Python Enhancement Proposal,PEP)。PEP 8是最古⽼的PEP之⼀,它向Python程序员提供了代码格式设置指南。PEP 8的篇幅很长,但⼤都与复杂的编码结构相关。
Python格式设置指南的编写者深知,代码被阅读的次数⽐编写的次数多。代码编写出来后,调试时你需要阅读它;给程序添加新功能时,需要花很长的时间阅读代码;与其他程序 员分享代码时,这些程序员也将阅读它们。
如果⼀定要在让代码易于编写和易于阅读之间做出选择,Python程序员⼏乎总是会选择后者。下⾯的指南可帮助你从⼀开始就编写出清晰的代码。
1 缩进
PEP 8建议每级缩进都使⽤四个空格,这既可提⾼可读性,⼜留下了⾜够的多级缩进空间。 在字处理⽂档中,⼤家常常使⽤制表符⽽不是空格来缩进。对于字处理⽂档来说,这样做的效果很好,但混合使⽤制表符和空格会让Python解释器感到迷惑。每款⽂本编辑器都提供了⼀种设置,可将输⼊的制表符转换为指定数量的空格。你在编写代码时应该使⽤制表符键,但⼀定要对编辑器进⾏设置,使其在⽂档中插⼊空格⽽不是制表符。 在程序中混合使⽤制表符和空格可能导致极难解决的问题。如果你混合使⽤了制表符和空格,可将⽂件中所有的制表符转换为空格,⼤多数编辑器都提供了这样的功能。
2 ⾏长
很多Python程序员都建议每⾏不超过80字符。最初制定这样的指南时,在⼤多数计算机中,终端窗⼝每⾏只能容纳79字符;当前,计算机屏幕每⾏可容纳的字符数多得多,为何还 要使⽤79字符的标准⾏长呢?这⾥有别的原因。专业程序员通常会在同⼀个屏幕上打开多个⽂件,使⽤标准⾏长可以让他们在屏幕上并排打开两三个⽂件时能同时看到各个⽂件 的完整⾏。PEP 8还建议注释的⾏长都不超过72字符,因为有些⼯具为⼤型项⽬⾃动⽣成⽂档时,会在每⾏注释开头添加格式化字符。PEP 8中有关⾏长的指南并⾮不可逾越的红线,有些⼩组将最⼤⾏长设置为99字符。在学习期间,你不⽤过多地考虑代码的⾏长,但别忘了,协作编写程序时,⼤家⼏乎都遵守 PEP 8指南。在⼤多数编辑器中,都可设
置⼀个视觉标志——通常是⼀条竖线,让你知道不能越过的界线在什么地⽅。注意 附录B介绍了如何配置⽂本编辑器,以使其:在你按制表符键时插⼊四个空格;显⽰⼀条垂直参考线,帮助你遵守⾏长不能超过79字符的约定。
3 空⾏
要将程序的不同部分分开,可使⽤空⾏。你应该使⽤空⾏来组织程序⽂件,但也不能滥⽤;只要按本书的⽰例展⽰的那样做,就能掌握其中的平衡。例如,如果你有5⾏创建列表 的代码,还有3⾏处理该列表的代码,那么⽤⼀个空⾏将这两部分隔开是合适的。然⽽,你不应使⽤三四个空⾏将它们隔开。空⾏不会影响代码的运⾏,但会影响代码的可读性。Python解释器根据⽔平缩进情况来解读代码,但不关⼼垂直间距。
三 个⼈感触:
虽然这些原则很简单,但是⼜有多少⼈能够遵循的很好呢?最珍贵的原则往往是简洁的。希望对代码有追求的程序员能够好好地遵循这个原则,造福后⼈。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论