一日一技:Python自带的文档生成模块

简介: 一日一技:Python自带的文档生成模块

图片摄影:产品经理

厨师:kingname

如果我们的注释写的足够规范,Python能够自动为我们生成非常好看的文档。

生成文档的模块叫做 pydoc,当我们安装完成Python以后,它就会被自动添加进环境变量里面。

为了演示 pydoc的使用方法,我们先创建两个.py文件,如下面两张图所示:

代码里面的注释已经解释了每个模块的功能,但是注释和代码混着毕竟看起来不方便,所以我们可以使用 pydoc来把注释生成文档。

在终端里面进入代码所在的文件夹,运行如下代码:

python3 -m pydoc SuperSpider

运行效果如下图所示:

文档和Linux的 man生成的文档别无二致。并且可以通过键盘上的 j或方向键下往下滚动屏幕,或者键盘上的 k或者方向键上往上滚动屏幕。

如果你觉得在命令行下面依然不方便,那么还可以自动生成一个HTTP服务。在当前文件夹下面执行命令:

python3 -m pydoc -p 8877

其中的 8877是端口号,你可以改成任何一个没有被占用的端口。

此时界面如下图所示:

在浏览器中打开:127.0.0.1:8877,可以看到如下页面:

其中箭头所指的地方就是你的模块。点进去就能看到代码文档了:

只要你按照PEP8的规范来写注释,那么这些注释都能通过pydoc直接转换为文档。

目录
相关文章
|
2月前
|
开发者 Python
如何在Python中管理模块和包的依赖关系?
在实际开发中,通常会结合多种方法来管理模块和包的依赖关系,以确保项目的顺利进行和可维护性。同时,要及时更新和解决依赖冲突等问题,以保证代码的稳定性和可靠性
74 4
|
1月前
|
Python
Python Internet 模块
Python Internet 模块。
125 74
|
2月前
|
算法 数据安全/隐私保护 开发者
马特赛特旋转算法:Python的随机模块背后的力量
马特赛特旋转算法是Python `random`模块的核心,由松本真和西村拓士于1997年提出。它基于线性反馈移位寄存器,具有超长周期和高维均匀性,适用于模拟、密码学等领域。Python中通过设置种子值初始化状态数组,经状态更新和输出提取生成随机数,代码简单高效。
130 63
|
2月前
|
数据可视化 Python
如何在Python中解决模块和包的依赖冲突?
解决模块和包的依赖冲突需要综合运用多种方法,并且需要团队成员的共同努力和协作。通过合理的管理和解决冲突,可以提高项目的稳定性和可扩展性
|
2月前
|
测试技术 Python
手动解决Python模块和包依赖冲突的具体步骤是什么?
需要注意的是,手动解决依赖冲突可能需要一定的时间和经验,并且需要谨慎操作,避免引入新的问题。在实际操作中,还可以结合使用其他方法,如虚拟环境等,来更好地管理和解决依赖冲突😉。
|
17天前
|
Python
[oeasy]python057_如何删除print函数_dunder_builtins_系统内建模块
本文介绍了如何删除Python中的`print`函数,并探讨了系统内建模块`__builtins__`的作用。主要内容包括: 1. **回忆上次内容**:上次提到使用下划线避免命名冲突。 2. **双下划线变量**:解释了双下划线(如`__name__`、`__doc__`、`__builtins__`)是系统定义的标识符,具有特殊含义。
26 3
|
2月前
|
持续交付 Python
如何在Python中自动解决模块和包的依赖冲突?
完全自动解决所有依赖冲突可能并不总是可行,特别是在复杂的项目中。有时候仍然需要人工干预和判断。自动解决的方法主要是提供辅助和便捷,但不能完全替代人工的分析和决策😉。
|
2月前
|
Python
Python的模块和包
总之,模块和包是 Python 编程中非常重要的概念,掌握它们可以帮助我们更好地组织和管理代码,提高开发效率和代码质量
56 5
|
2月前
|
JavaScript 前端开发 Python
python中的OS模块的基本使用
欢迎来到瑞雨溪的博客,一名热爱JavaScript与Vue的大一学生。博客分享前端技术及全栈开发经验,持续更新中,期待您的关注和支持!🎉🎉🎉
47 0
|
2月前
|
JavaScript 前端开发 Python
python中的platform模块的基本使用
欢迎来到瑞雨溪的博客,一名热爱JavaScript与Vue的大一学生。博客分享前端技术,助你成长。关注我,持续更新中!🎉🎉🎉
37 0

热门文章

最新文章