根据 ‘C语言中文网’ 该链接下的文章学习整理,点击此处即可访问。本文对此进行了提炼精简并做了适当的修改,如有侵权请私信我删除。
Python 的 pydoc 模块可以非常方便地查看、生成帮助 HTML 文档,以下的create_pythonDoc.py 模块作为示例.
# create_pythonDoc.py
My_NAME = 'PYDOC学习'
def say_hi(name):
'''
定义一个打招呼的函数
返回对指定用户进行打招呼
'''
print('执行函数')
return 'HELLO' + 'name'
def print_rect(height, width):
'''
定义一个打印矩形的函数
height - 代表矩形的高
width - 代表矩形的宽
'''
print(('*' * width + '\n') * height)
class User:
'''
定义一个代表用户的类
该类包括name, age两个变量
'''
def __init__(self, name, age):
'''
name初始化该用户的name
age初始化该用户的age
'''
self.name = name
self.age = age
def introduce_myself(self):
'''
定义了用户进行自我介绍的方法
'''
print('我叫 %s, 我今年 %d 岁' % (self.name, self.age))
1.控制台查看文档
切换到该模块的目录下,在 cmd 控制台执行 python -m pydoc create_pythonDoc 命令,在控制台会显示生成的 python 文档
参数-m,表示运行指定模块
2.pydoc 生成 HTML文 档
在cmd控制台中 python -m pydoc -w create_pythonDoc
参数 -w,表示 write 输出 HTML 文档
3.启动本地服务器来查看文档信息
在cmd控制台中输入:python -m pydoc -p 8090 -b
参数 -p表示指定端口号,参数 -b表示选择浏览器启动查看
4.pydoc 查找模块
在cmd控制台中输入:python -m pydoc -k say_hi(被搜索模块的部分内容)