《Python语言程序设计》——1.7 程序设计风格和文档

本节书摘来自华章计算机《Python语言程序设计》一书中的第1章，第1.7节,作者：［美］梁勇（Y. Daniel Liang） 更多章节内容可以访问云栖社区“华章计算机”公众号查看。

1.7　程序设计风格和文档

关键点：好的程序设计风格和正确的文档可以让程序易读并防止出错。
程序设计风格指的是程序的整个样子。当用专业的程序设计风格创建程序时，它们不但会正确执行，而且也会易于阅读、便于理解。这对访问或修改你的程序的其他程序员来说是非常重要的。
文档是属于一个程序的解释性备注和注释的主体。这些备注和注释对程序的不同部分进行解释，帮助其他人更好地理解它的结构和功能。对本章前面的内容，备注和注释都是嵌在程序内部里，当执行程序时Python的解释器会直接忽略它们。
程序设计风格和文档与编码一样重要。下面是几个建议规范。
1.7.1　恰当的注释和注释风格
在程序开始的地方要有一个总结性的注释，它解释这个程序是干什么的、其重要特征以及所使用的独特技术。在大程序中，应该有注释介绍每个主要步骤以及任何难以读懂的内容。注释简洁明了是非常重要的，因此，不要让它们密密麻麻，也不要让它们难以阅读。
1.7.2　恰当的空格
一致的空格风格可以让程序更加清晰且易于阅读、调试（找到且解决错误）以及维护。
一个运算符的两边都应该添加一个空格，如下面的语句所示：

更多的建议规范可以在配套网站的补充材料I.F中找到。