第十五章、文档

Python文档资源

Python预置的功能数量惊人：内置函数和异常、预先定义的对象属性和方法、标准库模块等。

1、#注释：

井字号注释是代码编写文档的最基本方式。Python会忽略#之后所有文字（只要#不是位于字符串常量中），所以你可以在这个字符之后插入一些对程序员有意义的文字和说明。

2、dir函数：

内置的dir函数是抓取对象内可用所有属性列表的简单方式（例如，对象的方法以及较简单的数据项）。它能够调用任何有属性的对象。

3、文档字符串：__doc__：

除了#注释外，Python也支持可自动附加在对象上的文档，而且在运行时还可保存查看。从语法上说，这类注释是写成字符串，放在模块文件、函数以及类语句的顶端，就在任何可执行程序代码前（#注释在其之前也没问题）。Python会自动封装这个字符串，也就是成为所谓的文档字符串，使其成为相应对象的__doc__属性。

①、用户定义的文档字符串：

文档协议的重点在于，注释会保存在__doc__属性中以供查看（文件导入之后）。

②、文档字符串标准：

目前文档字符串的结构没有标准。

③、内置文档字符串：

Python中的内置模块和对象都使用类似的技术，在dir返回的属性列表前后加上文档。

4、PyDoc：help函数：

标准PyDoc工具是Python程序代码，知道如何提取文档字符串并且自动提取其结构化的信息，并将其格式化成各种类型的排列友好的报表。

5、PyDoc：HTML报表：

PyDoc有提供GUI接口（简单并且可移植的Python/Tkinter脚本），可以将其报表通过HTML网页格式来呈现，可通过任何网页浏览器来查看。

6、标准手册集：

为了获得语言以及工具集最新的完整说明，Python标准手册随时可以提供支持。

7、网络资源：

8、已出版的书籍：

常见编写代码的陷阱

①、别忘了冒号。

②、从第一行开始。

③、空白行在交互模式提示符下很重要。

④、缩进要一致。

⑤、不要在Python中写C代码。

⑥、使用简单的for循环，而不是while或range。

⑦、要注意赋值语句中的可变对象。

⑧、不要期待在原处修改对象的函数会返回结果。

⑨、一定要使用括号调用函数。

⑩、不要在导入和重载中使用扩展名和路径。

本章小结

本章带我们进行了程序的文档概念之旅。我们为程序编写文档，以及内置工具的文档。我们见到了文档字符串，探索过Python的在线手册等参考资源，并且学习了PyDoc的help函数和网页接口是如何提供额外的文档来源的。因为这是本书这一部分的最后一章，我们也复习了常见的编写代码的错误，从而有助于你避开这些陷阱。