专栏首页未闻Code一日一技: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直接转换为文档。

本文分享自微信公众号 - 未闻Code(itskingname),作者:kingname

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2019-07-26

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 一日一技:对函数返回的多个值进行封装

    如果你经常使用Python的第三方科学计算库或者AI库,你会发现这些库的一些方法喜欢一次性返回非常多的值,像下面这样:

    青南
  • 如果你不知道做什么,那就学一门杂学吧

    多年以后,面对人工智能研究员那混乱不堪的代码,我会想起第一次和S君相见的那个遥远的下午。那时的B公司,还是一个仅有6个人的小团队,Mac和显示器在桌上依次排开,...

    青南
  • 博弈论(一)——产品小哥哥的民主妙计

    “作为一个产品,一定要与开发一起对项目有深入的沟通和交流,才能让项目做的更好。所以,今天我们来做一个不记名投票,确定哪几位同学可以和我一起讨论产品的设计方向。”

    青南
  • 【你找茬儿,我发奖】腾讯云产品文档“捉虫”活

    答:“腾讯云文档有奖反馈活动”是为激励广大用户积极反馈遇到的文档问题而长期开展的一项用户回馈活动,覆盖全产品文档,长期有效。

    腾讯云文档
  • 文本获取和搜索引擎的概率模型

    coursera课程 text retrieval and search engine 第四周 推荐。

    爬蜥
  • 微信分享

    微信分享,咋一看好像很复杂,实则非常简单。只需要调用微信官方出的微信jssdk,加上些许配置,就可以实现h5页面在微信上的分享,官方文档戳这里

    grain先森
  • 作业车间调度JSP与遗传算法GA及其Python/Java/C++实现

    最近小编接触了遗传算法(Genetic Algorithm)。关于遗传算法,公众号内已经有多盘技术推文介绍:

    短短的路走走停停
  • Java基础提升篇:理解String 及 String.intern() 在实际中的应用

    好好学java
  • 你可能并不知道这样定制炫酷的jupyter主题

    之前用多了mac,习惯了苹果“友好”的字体和界面,最近在windows上使用jupyter notebook的时候,总觉得界面不是很舒服,见下面的效果图,尤其是...

    超哥的杂货铺
  • 分子对接简明教程 (4)

    文件格式解释 PDB文件 (详细格式描述) 基本信息部分 HEADER记录: 包括分子的分类、提交日期、PDB ID TITLE记录: 为该结构的描述,如果有多...

    生信宝典

扫码关注云+社区

领取腾讯云代金券