一.常用的两种代码规范
- 《8 号 Python 增强规范》(Python Enhacement Proposal #8),简称 PEP8;
- 《Google Python 风格规范》(Google Python Style Guide),简称 Google Style,这是源自 Google 内部的风格规范。公开发布的社区版本,是为了让 Google 旗下所有 Python 开源项目的编程风格统一。
相对来说,Google Style 是比 PEP8 更严格的一个编程规范。因为 PEP8 的受众是个人和小团队开发者,而 Google Style 能够胜任大团队,企业级,百万行级别代码库。
二.统一的编程规范为什么重要?
用一句话来概括,统一的编程规范能提高开发效率。而开发效率,关乎三类对象,也就是阅读者、编程者和机器。他们的优先级是阅读者的体验 >> 编程者的体验 >> 机器的体验。
阅读者的体验 >> 编程者的体验
写过代码的人可能都有体会,在我们的实际工作中,真正在打字的时间,远比阅读或者 debug 的时间要少。事实正是如此,研究表明,软件工程中 80% 的时间都在阅读代码。所以,为了提高开发效率,我们要优化的,不是你的打字时间,而是团队阅读的体验。
编程者的体验 >> 机器的体验
如果你用一个简单的 for loop,会让这段代码更加简洁明了,自己也更为轻松。
# 错误示例
result = [(x, y) for x in range(10) for y in range(5) if x * y > 10]
# 正确示例
result = []
for x in range(10):
for y in range(5):
if x * y > 10:
result.append((x, y))
机器的体验也很重要
我们最终希望代码能正确、高效地在电脑上执行。但是,一些危险的编程风格,不仅会影响程序正确性,也容易成为代码效率的瓶颈。