Ka-Ping Yee 曾创建了一个相当著名的模块，名叫 pydoc （比较而言： pydoc 可以做到 perldoc 所能做的任何事，并且做得更好、更漂亮:-）。对于 Python 2.1 来说， pydoc （以及它支持的 inspect ）是标准库的一部分。而对于使用 Python 1.5.2、1.6 或者 2.0 版本的用户来说，下载并安装 pydoc 也很简单 ― 请立即下载（请参阅 参考资料）。
作为提供给阅读这篇 Python 文章的任何初学者的背景资料，Python 一直有些半正式的文档标准。这些标准并没有试图过度地限制开发者，而是给开发者提供“一种明显的写文档的方法。”幸运的是，通常情况下，Python 开发者所写的文档比使用其它语言的典型开发者所写的要好得多。
Python 文档之所以“优秀”的主要因素是使用所谓的“docstring”。虽然 docstring 实际上只是一个被称为 _doc_ 的变量，但还是有一个普遍使用的创建它们的快捷方式：只要在模块、函数 def 、类定义或方法 def 的头部放入一个简单的由（三重）引号括起来的字符串。此外，还有几个接近标准的模块级的“魔术”变量名被经常使用。尽管那些文档规则不太正式，但几乎所有第三方的模块和标准模块的文档都使用相同的模式。
转自： https://www.ibm.com/developerworks/cn/linux/sdk/python/charm-19/
时间： 2024-10-27 05:57:26