python02(pydoc的使用)

一、启动本地服务,在web上查看文档

pydoc是python自带的一个文档生成工具,使用pydoc可以很方便的查看类和方法结构

python中pydoc模块可以从python代码中获取docstring,然后生成帮助信息。

pydoc是Python自带的模块,主要用于从python模块中自动生成文档,这些文档可以基于文本呈现的、也可以生成WEB 页面的,还可以在服务器上以浏览器的方式呈现!

使用命令行: python -m pydoc -p 7090

就可以在本地机器按照给定的端口启动HTTP:http://localhost:7090/

说明:
1、-p指定启动的服务的端口号,可以随意指定不冲突的端口号
2、只有在自建的工程根目录下使用该命令,才能看到当前工程下所有的内容,否则只能看到python环境变量下的模块内容
 
二、直接查看某个py文件的内容
例子:新建了一个py文件叫做practice10.py,进入practice10.py所在目录
python -m pydoc practice10
 
此方法能看到该py文件的里全部内容和结果
 
三、生成html说明文档
例子:新建了一个py文件叫做testpydoc.py,进入practice09.py所在目录
python -m pydoc -w practice09
 
会默认将当前目录下的practice09生成一个叫做practice09.html的文档,如果是目录直接【python -m pydoc -w 目录名】生成文档
 
说明:如果是将整个目录生成这种格式,不建议用这种方式,因为如果他展示目录下的子文件的说明时,会去子目录下找对应.html文件,如果文件不存在,就会404
 

猜你喜欢

转载自www.cnblogs.com/stacy828/p/9771638.html