python文档

一、查看文档的方法

第一步:cmd窗口输入:python -m pydoc -p 0,后台运行

Snipaste_2020-01-06_20-04-10.png

第二步:浏览器中打开http://localhost:17165/

45.png

说明:

1、-p指定启动的服务的端口号,可以随意指定不冲突的端口号

2、只有在自建的工程根目录下使用该命令,才能看到当前工程下所有的内容,否则只能看到python环境变量下的模块内容

3、如果本地只有一个python,可以直接使用【pydoc -p 端口号】启动,但因为我本地有python2和python3,所以指定了用python3

二、html文档说明

通过查看文档的方法,我们可以看到在html的文档主要分成四部分:py文件的顶部注释、Classes、Functions、Data

(示例代码见结尾部分)

第一部分:模块的文档说明,展示模块顶部的多行注释

注释内如果包含了模块文件内的class名,或方法名(),则显示蓝色,且可以点击跳转到对应说明位置

第二部分:classes,展示class以及class下的function

1.只能展示class下的注释,不会展示class下方法的注释

2.class上面有#注释时,展示#号的注释

3.class下有”””多行注释”””时优先展示多行注释,就不展示顶部的#号的注释了

第三部分:function,模块下的def方法,不是class中的方法

1.function上面有#注释时,展示#号的注释

2.function下有”””多行注释”””时优先展示多行注释,就不展示顶部的#号的注释了

第四部分:data,模块下直接定义的变量,不是function或class的变量

原文地址:https://www.cnblogs.com/tomyyyyy/p/12162621.html