python注释文档

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

1、注释文档

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

1、注释文档

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

#!/usr/bin/env python# -*-coding:utf-8 -*-

# annotation.py

''' 文档快速生成注释的方法介绍,首先我们要用到__all__属性在Py中使用为导出__all__中的所有类、函数、变量成员等在模块使用__all__属性可避免相互引用时命名冲突'''

__all__ = ['Login', 'check', 'Shop', 'upDateIt', 'findIt', 'deleteIt', 'createIt']

class Login: ''' 测试注释一可以写上此类的作用说明等例如此方法用来写登录 ''' def __init__(self): ''' 初始化你要的参数说明 ''' pass def check(self): ''' 协商你要实现的功能说明 ''' passclass Shop: ''' 商品类所包含的属性及方法 update改/更新 find查找 delete删除 create添加 ''' def __init__(self): ''' 初始化商品的价格、日期、分类等 ''' pass def upDateIt(self): ''' 用来更新商品信息 ''' pass def findIt(self): ''' 查找商品信息 ''' pass def deleteIt(self): ''' 删除过期下架商品信息 ''' pass def createIt(self): ''' 创建新商品及上架信息 ''' passif __name__=="__main__": import annotation print help(annotation)

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

1）访问模块注释

2）访问类注释

3）访问函数注释

4）修改__doc__

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

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

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

http://blog.csdn.net/u013810296/article/details/55509284

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

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

参考文章

1、python快速生成注释文档的方法

https://www.cnblogs.com/cookie1026/p/6093188.html

python注释文档相关推荐

python注释文档，以注释生成文档说明
Python有一种独一无二的的注释方式:使用文档字符串,文档字符串是包.模块.类或函数里的第一个语句,这些字符串可以通过对象的__doc__成员被自动提取,并且被pydoc所用. 目录 1.注释文档 ...
Python快速生成注释文档
Python为我们生成基本满足的说明文档,一来可以提高代码整体阅读性,二来可以将代码的整体结构看着也更清晰. 注意:注释的地方和函数名类名都是与__all__内相关联的简单的代码格式: #!/usr ...
Doxygen生成注释文档
最终效果最终通过文件的注释,生成一个帮助文档. 软件安装需要安装3个软件 1.Doxygen 2.graphviz(可以根据文件的引用关系生成调用关系图) 3.htmlhelp(生成windos脱 ...
名词解释（容器、并发，插件，脚本）及程序对象的创建和注释文档
一.专有名词 1' 容器创建一种对象类型,持有对其他对象的引用,被称为容器的新对象.在任何时候都可以扩充自己以容纳置于其中的所有东西. java在其标准类库中包含了大量的容器.在某些类库中,一两个通 ...
C#.NET必备工具GhostDoc为代码生成注释文档
使用GhostDoc为代码生成注释文档 [转自www.bitsCN.com] 介绍: GhostDoc是Visual Studio的一个免费插件,可以帮助开发人员编写XML格式的注释文档. ...
python精要（66）—类（3）－文档字符串，注释文档
#!/usr/bin/env python3 # -*- coding: utf-8 -*- """ Created on Mon Feb 22 08:35:42 202 ...
Android Studio javadoc 生成注释文档
相信大家刚开始写代码的时候就被前辈告知了要养成写注释的好习惯,今天我们来了解一下如何利用我们平时写的注释生成文档,一起来看看吧! 其实注释格式一般如下两种: /* *普通多行 *注释 */ / ...
c++ doxygen 注释规范_利用Doxygen给C程序生成注释文档
利用Doxygen为C程序生成注释文档一.Doxygen工具的安装利用Doxygen工具生成API帮助文档需要下载安装以下三个软件: (1)Doxygen:可以从一套归档源文件开始,生成HTML格 ...
福昕PDF阅读器无法修改、注释文档，解决办法！
最近在阅读一篇PDF文档时,对一些内容进行高亮时,发现不能够进行高亮,然后通过在网上查找解决方法算是解决了我的问题.下面我将总结2点不能进行注释的情况,并且附上解决方法,希望对各位有所帮助吧.我使用福 ...

python注释文档

python注释文档相关推荐

最新文章

热门文章