注释文档的生成

 

生成注释文档：

1、进入代码文件所在目录路径：

 

2、听课时讲师写的是python3，但是我的环境python3出不来，用python就可以。

# 1.查看注释文档的帮助文档
python -m pydoc -h

# 2.检索含有关键字的模块
python -m pydoc -k 关键字

# 3.python为版本，1233为指定端口
python -m pydoc -p 1233

# 4.相比于-p，不用写端口，自动寻找闲置端口，且可自动打开浏览器显示
python -m pydoc -b 

# 5.文件名不用加.py后缀，生成html文件，可以右键文件在浏览器打开
python -m pydoc -w 文件名

 

查看帮助文档：

 

3.复制网址到浏览器查看生成的注释文档：python -m pydoc -p 端口

   注意：若在cmd中输入 q 退出以下操作，即关闭服务器，下述网址将打不开。

 

 

4、自动寻找闲置端口，且自动打开浏览器网址：python -m pydoc -b

 

 5、执行“python -m pydoc -w 需生成模块注释的模块名”，在同级目录下会自动生成对应的HTML文件，可直接打开查看。