Python有一种独一无二的的注释方式：使用文档字符串，文档字符串是包、模块、类或函数里的第一个语句，这些字符串可以通过对象的__doc__成员被自动提取，并且被pydoc所用。
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):
''' 协商你要实现的功能说明 '''
pass
class
Shop:
''' 商品类所包含的属性及方法 update改/更新 find查找 delete删除 create添加 '''
def
__init__
(self):
''' 初始化商品的价格、日期、分类等 '''
pass
def
upDateIt(self):
''' 用来更新商品信息 '''
pass
def
findIt(self):
''' 查找商品信息 '''
pass
def
deleteIt(self):
''' 删除过期下架商品信息 '''
pass
def
createIt(self):
''' 创建新商品及上架信息 '''
pass
if
__name__
==
"__main__"
:
import
annotation
print
help(annotation)
可以通过，__doc__访问任何函数，类，模块中文档注释。
1）访问模块注释
2）访问类注释
3）访问函数注释
4）修改__doc__
这种修改并不修改文档内容本身。
2、查看python的模块和函数帮助文档方法
这里介绍下python自带的查看帮助功能，可以在编程时不中断地迅速找到所需模块和函数的使用方法。
help(模块名)，查看对性完整注释
dir(模块名)，查看对象属性
参考文章
1、
python快速生成注释文档的方法