python doc 简要介绍

Java有Javadoc可以方便的生成帮助文档。python 有pydoc，只要源文件按照docstring的标准（PEP 257）来写，就可以很方便的生成帮助文件。

http://www.python.org/dev/peps/pep-0257/

下面简单的就PEP 257来说明一下

什么是docstring？docstring 就是出现在模块，方法，类后面的第一句声明，这句声明会默认成为，该对象的__doc__变量的内容。

所有的模块（module)通常有docstring，模块中对外引用的函数和类也需要有docstring，公共函数（包括__init__构造器）也应该有DocString，如果是包，可以在包的根目录中的__init__.py文件中写这个模块(module）的DocString。

其他位置书写的文本可能不会做为文档被识别，但是可能被其他的工具识别。

为了保持一致性，使用三引号将 DocString包含，例如： """triple  double   quotes"""，包含转义字符（'\'）的DocString需要使用转