Python3学习笔记 | 十七、Python的语句与语法－文档

一、Python文档资源

在之前章节中，介绍的一些方法等，都是不全的。对于一个类型，有多少个方法、或者参数、属性等，需要查看文档。下面介绍Python里几种文档形式。

注释 - 文件中的文档

dir函数 - 对象中，可用属性列表 文档字符串：doc - 附加在对象上的文件中的文档 PyDoc: help函数 - 对象的交互帮助 PyDoc: HTML报表 - 浏览器中的模块文档 标准手册 - 正式的语言和库的说明 网站资源 - 在线教程、例子等 出版的书籍 - 商业参考书籍

下面一一查看：

二、#注释

井字号注释是代码编写文档的最基本方式。Python解析时会忽略#注释后面的内容（只要#不在文本字符串里）。

文档字符串（doc方式可以访问的内容）适用于大型开发里，而#注释适用于较小功能的开发里。之后内容中会介绍到文档字符串。

注释例子：

#这个是测试两个变量相加的语句
def myadd(a, b):
    return a + b
#结果返回两个变量之和。

三、dir函数

dir函数会返回可用所有属性列表的方式。它能够调用任何有属性的对象。 使用方式：dir(‘’), dir(1), dir([]) 上面结果等同于：dir(str), dir(int), dir(list) 之后会说明help函数。dir函数可以被认为是help函数的精简版。

四、文档字符串: doc

文档字符串是，在类、函数、方法等模块里，以字符串方式存储的文档。当需要调用时，对相应模块调用doc参数，就可以查看。

>>> import sys
>>> print(sys.__doc__)
This module provides access to some objects used or maintained by the
interpreter and to functions that interact strongly with the interpreter.
....

自己创建文档字符串：

>>> def test_doc():
... "This is test document"
... pass
...
>>> test_doc.__doc__
'This is test document'

五、PyDoc: help函数

在之前介绍的dir函数，可以把所有可用的参数、函数等列出来，但没有具体介绍。想了解具体使用方法，可以使用help函数。

>>> help(test_doc)
Help on function test_doc in module __main__:
test_doc()
This is test document
>>> help(sys)
Help on built-in module sys:
NAME
sys
MODULE REFERENCE
...

六、其他

PyDoc：HTML报表：GUI方式的时候可以使用。不多做解释。

标准手册集： 可以在www.python.org下载的文档。