Python编程：使用pydoc生成文档注释

pydoc是python自带的一个文档生成工具，可以提取注释

如果有三个引号的注释方法，会优先使用三个点的注释，其次才展示#号的注释

示例使用的代码pydoc_demo.py，包含一个函数，一个类

# -*- coding: utf-8 -*-# @Date    : 2018-10-30
# @Author  : Peng Shiyu"""
这个文档注释pydoc的示例
"""# 函数名上方的文字
def func():"""函数名下方的注释@return: None"""print("hello")# 类名上方的文字
class Demo():"""类名下方的文字"""# 类中方法上方的文字def hello(self):"""类中方法下方的文字@return: None"""print("hello")

生成文档

$ pydoc pydoc_demo > doc.md

将文档重定向到doc.md文件中，内容如下

Help on module pydoc_demo:NAMEpydoc_demo - 这个文档注释pydoc的示例CLASSESbuiltins.objectDemoclass Demo(builtins.object)|  类名下方的文字|  |  Methods defined here:|  |  hello(self)|      类中方法下方的文字|      @return: None|  |  ----------------------------------------------------------------------|  Data descriptors defined here:|  |  __dict__|      dictionary for instance variables (if defined)|  |  __weakref__|      list of weak references to the object (if defined)FUNCTIONSfunc()函数名下方的注释@return: NoneFILE/demo/pydoc_demo.py

生成html

$ pydoc -w pydoc_demo

出现新文件pydoc_demo.html

颜色看上去很鲜艳

参考
pydoc用法

Python编程：使用pydoc生成文档注释相关推荐

windows下javadoc生成文档注释的命令
windows下javadoc生成文档注释的命令 javadoc -d myHello -author -version HelloWorld.java
Java之生成文档注释
在实际开发中,我们经常需要生成文档注释,下面简单记录一下如何生成文档注释,以下是使用EditPlus编写的java文档生成的注释. 帮助文档: 1)使用JDK,JDK中类有很多,都可以使用,了解这些类 ...
python使用sphinx自动生成文档
python代码注释风格有很多,比较主流的有reStructuredText风格.numpy风格.google风格,pycharm默认提示reStructuredText风格 reStructured ...
使用Pydoc生成文档
Python中本身带有很多实用的工具,如pydoc.pydoc模块主要用来从Python模块中提取信息并生成文档. 使用方法在Windows和Linux下的使用方法有些区别. Windows pyt ...
idea模板注释快捷键_idea生成文档注释快捷键
技术文档主体内容:可以认为是页面最想表达的内容总和.对于内容详情页来说,主体内容指从标题开始至正文内容结束,翻页区域也被视为主体内容,文章后的评论.分享.推荐等不视为主体内容. 首屏:用户点击搜索结 ...
idea创建文件时生成文档注释
一.打开设置(快捷键Ctrl+Alt+S) 打开idea,点击左上角的依次选择File - Settings,进入Settings界面二.找到 ' File and Code Templates ' ...
java怎样生成文档_关于如何生成Java文档
一.生成Java文档,要明白Java注释内容,如果不知道,可以去看上一篇文章. 二.Java系统提供的javadoc工具可以根据程序结构自动生成注释文档.当程序修改时可方便及时更新生成的注释文档.ja ...
python 自动生成文档
python 自动生成文档 python 自动生成文档一.配置文档二.protobuf 三.代码 python 自动生成文档一.配置文档 register.temeprate # Datetim ...
Doxygen——根据代码注释生成文档的工具
文章目录 1 简介 2 安装 3 使用 3.1 注释代码 3.2 使用doxywizard生成文档 4 用例 4.1 OpenCV 4.2 Apollo 5 参考 1 简介 Doxygen是一个可以根 ...

Python编程：使用pydoc生成文档注释

生成文档

生成html

Python编程：使用pydoc生成文档注释相关推荐

最新文章

热门文章