Python学习笔记（十）：Python文档

以Mark Lutz著的《Python学习手册》为教程，每天花1个小时左右时间学习，争取两周完成。 --- 写在前面的话

2013-7-20 20:00 学习笔记

1，Python以#开始代码注释。Python也支持可自动附加在对象上的文档，而且可以在运行时查看。这类注释是写成字符串，放在模块文件、函数、类语句的顶端，就是在任何可执行代码前（#注释在其前没有问题）。Python会自动封装这个字符串，也就是成为所谓的文档字符串，使其成为对象的__doc__属性。例如：

"""
Module documentation
Words Go Here
"""

spam = 40

def square(x):
	"""
	function documentation
	Words Go Here
	"""
	return x**2
	
class employee:
	"class documentation"
	pass

2，Python有一个PyDoc工具，可以来查看文档字符串信息。在命令行模式下，通过help函数启动PyDoc。在GUI模式下，可以直接查看HTML网页格式的文档信息。

3，Python的标准手册可以从http://www.python.org获得，是Python语句及其工具集的最新完整说明。在Windows上，该标准手册是随Python一起被安装的。

4，dir()函数用于列出对象的所有属性，可以传入所需类型的常量。例如：

dir([])
dir('')

5，一些Python代码编写陷阱：

• 不要忘记冒号:
• 程序代码要从第1行开始
• 缩进要一致
• 不要在Python中写C语言风格的代码
• 尽量使用简单的for循环，而不是while和range
• 一定要使用括号调用函数
• 不要在导入或重载时使用扩展名或路径