Python有一种独一无二的的注释方式：使用文档字符串，文档字符串是包、模块、类或函数里的第一个语句，这些字符串可以通过对象的__doc__成员被自动提取，并且被pydoc所用。

1、注释文档

2、查看python的模块和函数帮助文档方法

1、注释文档

一个文档字符串应该这样组织：首先是一行以句号，问号或惊叹号结尾的概述(或者该文档字符串单纯只有一行)。接着是一个空行，接着是文档字符串剩下的部分，它应该与文档字符串的第一行的第一个引号对齐。

#!/usr/bin/env python# -*-coding:utf-8 -*-
# annotation.py''' 文档快速生成注释的方法介绍,首先我们要用到__all__属性在Py中使用为导出__all__
中的所有类、函数、变量成员等在模块使用__all__属性可避免相互引用时命名冲突'''__all__ = ['Login', 'Shop']class Login(object):''' 测试注释一可以写上此类的作用说明等 例如此方法用来写登录 '''def __init__(self):''' 初始化你要的参数说明 '''passdef check(self):''' 协商你要实现的功能说明 '''passclass Shop(object):''' 商品类所包含的属性及方法 update改/更新 find查找 delete删除 create添加 '''def __init__(self):''' 初始化商品的价格、日期、分类等 '''passdef upDateIt(self):''' 用来更新商品信息 '''passdef findIt(self):''' 查找商品信息 '''passdef deleteIt(self):''' 删除过期下架商品信息 '''passdef createIt(self):''' 创建新商品及上架信息 '''passif __name__ == "__main__":import annotationprint(help(annotation))

可以通过，__doc__访问任何函数，类，模块中文档注释。

1）访问模块注释

2）访问类注释

3）访问函数注释

4）修改__doc__

这种修改并不修改文档内容本身。

2、查看python的模块和函数帮助文档方法

这里介绍下python自带的查看帮助功能，可以在编程时不中断地迅速找到所需模块和函数的使用方法。查看python的模块和函数帮助文档方法_cheng3100的博客-CSDN博客_python文档

help(模块名)，查看对性完整注释

dir(模块名)，查看对象属性

参考文章

1、python快速生成注释文档的方法 python快速生成注释文档的方法 - Cookie-Fei - 博客园

python注释文档，以注释生成文档说明相关推荐

Doxygen——根据代码注释生成文档的工具
文章目录 1 简介 2 安装 3 使用 3.1 注释代码 3.2 使用doxywizard生成文档 4 用例 4.1 OpenCV 4.2 Apollo 5 参考 1 简介 Doxygen是一个可以根 ...
newlisp 注释生成文档
最近写了一个newlisp_armory库,用来实现一些newlisp自身不支持的操作.比如跨windows和ubuntu的目录拷贝功能等. 自己用的时候,发现没有API reference文档参考, ...
1.0 添加WEB API项目并按注释生成文档（多项目结构）
1.新建ASP.NET 项目,模板选择如图 2.选择Web API,并选择不进行身份验证方式成功后我们看到这个结果. 至于其它三种身份验证方式,不太适合我的使用.而且这种方式也可以在代码里去实现身份 ...
代码注释生成文档之Doxygen 附说明+下载连接
上个星期闫海静老师给我们讲如何使用PEAR把特定的批注转换成为说明文件,在闫海静老师给我们演示完安装和使用以后,我亲自操作了一下,感觉这东西对于我来说有点不适应,在安装过程中还需重启这让人有点无法接受 ...
js代码注释生成文档工具-jsdoc
需求将js和ts的代码注释生成api文档思路先将ts转成js,再统一处理js文件,用jsdoc工具来生成html文件. JsDoc 是js文档生成工具,它从javascript程序源代码中抽取类 ...
Objective-C自动生成文档工具:appledoc
作者 iOS_小松哥关注 2016.12.13 15:47* 字数 919 阅读 727评论 10喜欢 35 由于最近琐事比较多,所以好久没有写文章了.今天我们聊一聊Objective-C自动生成文 ...
Objective-C 自动生成文档工具:appledoc
来源:iOS_小松哥 www.jianshu.com/p/fd4d8d6b6177 如有好文章投稿,请点击 → 这里了解详情由于最近琐事比较多,所以好久没有写文章了.今天我们聊一聊Objective ...
t通过数据库逆向生成文档工具——screw
目录一.pom.xml准备二.工具类配置及生成三.导出示例(html) 四.说明目标将数据库表字段分表生成表单,自动对应表字段以及注释,可导出为 html | doc | md 文件一.p ...
使用Pydoc生成文档
Python中本身带有很多实用的工具,如pydoc.pydoc模块主要用来从Python模块中提取信息并生成文档. 使用方法在Windows和Linux下的使用方法有些区别. Windows pyt ...

python注释文档，以注释生成文档说明

1、注释文档

2、查看python的模块和函数帮助文档方法

python注释文档，以注释生成文档说明相关推荐

最新文章

热门文章