【有书共读01】《python学习手册》读书笔记九
Python文档资源
ps:《python学习手册》第十五章内容
为什么要使用文档资源?
因为Python预置的功能太多了,初学者不知道怎么找到这些内置工具的信息.
- #注释
#注释是代码编写文档的最基本方式.(书上原话.不太理解,应该是说是文档资源的最基本形式,即注释)
不过,#注释一般适用于小功能文档,因为只能在源代码里看到.
如果是大型功能的文档,一般使用文档字符串(下面介绍) - dir函数
内置的dir函数可以抓取对象内可用所有属性列表
例如 要找出requests模块有什么可以用,可以将其导入并传给dir函数#coding=utf-8 import requests print(dir(requests))
- 文档字符串:__doc__
除了#注释外,Python也支持自动附加在对象上的文档,而且在运行时还可保存查看.从语法来讲,这类注释是写成字符串放在模块文件.函数以及语句的顶端.Python会自动封装这个字符串.也就是成为所谓的文档字符串.
写在函数里可以作为一个函数的介绍,下面是举例子.
- help函数
上面我们可以看见,有一个help函数.help函数可以返回对象帮助信息
>>>help('sys') # 查看 sys 模块的帮助 ……显示帮助信息…… >>>help('str') # 查看 str 数据类型的帮助 ……显示帮助信息…… >>>a = [1,2,3] >>>help(a) # 查看列表 list 帮助信息 ……显示帮助信息…… >>>help(a.append) # 显示list的append方法的帮助 ……显示帮助信息……
地平线公司福利 422人发布
