pydoc模块(python自带)

最新推荐文章于 2024-06-28 14:15:56 发布

YPFeime

最新推荐文章于 2024-06-28 14:15:56 发布

阅读量2.9k

点赞数 2

分类专栏： python项目注释文档生成

本文链接：https://blog.csdn.net/YPFeime/article/details/104549357

版权

python项目注释文档生成专栏收录该内容

2 篇文章 0 订阅

订阅专栏

项目文档注释的查看方法

  条件：
    1：在项目的根目录执行
        python3 -m pydoc -b   :使用任务未被占用的端口
        或
        python3 -m pydoc -p 10011 ：使用指定的10011端口
    2：对于项目中的包， 包中必须有“__init__.py”文件， 才能被索引显示出来， 如果没有这个文件，pydoc
        会将其当做一个普通的目录， pydoc不会去递归索引这个目录。
    3：pydoc 只能显示python模块， 也就是以“.py”结尾的文件， 其他的不会被索引显示。

项目注释文档的生成(包中必须有“init.py”文件，才能被索引显示出来)

方法1 生成文本格式的注释文档

import pydoc
import sys
with open('aa.txt', 'w') as f:
	pydoc.doc('bin.socketServer', output=f)

方法2：使用help()函数, 生成的是文本格式的文档

import pydoc
import sys
# help() == pydoc.help() == pydoc.doc()  
sys.stdout = open('aa.txt', 'w')
help('bin.socketServer')
sys.stdout.close()
#  sys.stdout的作用是将输出到控制台的内容写
# 入文件(来自 https://blog.csdn.net/fengda2870/article/details/44925645 )
# 问题1：help函数会生成每一个类所有父类的注释文档， 所有公共父类会重复生成很多次注释，

方法3： pydoc.writedocs() 生成的是html格式的注释文档，推荐使用

import pydoc
import sys

# 方法1 和方法2 配合获取目录下所有文件(带绝对路径的文件)可以生成整个项目的注释文档
sys.path.append('/home/myubuntu/Desktop')
pydoc.writedocs('/home/myubuntu/Desktop')
#   /home/myubuntu/Desktop : 是项目文件夹所在的父目录
# 注意: 生成注释文档的py模块必须在项目目录的子目录中创建, 子子目录也可以。
# 方法3会生成一个“项目名字.html”文档， 这个文档可以放在项目目录下任何地方。 如果放在项目其他目录
# 不行，就复制这个文件，修改其中的<a>标签的链接指向“项目名字.html”这个文件即可(链接必须是相对路径)。



# 修改<a>标签的链接<a href="./doc_file/ABC.html"><strong>ABC</strong>&nbsp;(package)</a>
# doc_file是生成注释文档的目录
# 文件完整内容如下：
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package ABC</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">

<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>GMTestTool_ICCard</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><br><a href="file:/root/桌面/ABC/__init__.py">/root/桌面/ABC/__init__.py</a></font></td></tr></table>
    <p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>

<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr>
    <td width="25%" valign=top><a href="./doc_file/ABC.html"><strong>ABC</strong>&nbsp;(package)</a><br>
</td></tr></table></td></tr></table>
</body></html>

YPFeime

关注

2
点赞
踩
5

收藏

觉得还不错? 一键收藏
0
评论
pydoc模块(python自带)

项目文档注释的查看方法条件： 1：在项目的根目录执行 python3 -m pydoc -b :使用任务未被占用的端口或 python3 -m pydoc -p 10011 ：使用指定的10011端口 2：对于项目中的包，包中必须有“__init__.py”文件，才能被索引显示出来，如果没有这个文件，pydoc ...
复制链接

扫一扫