Python 有一种独特的注释方式：使用文档字符串。文档字符串是包、模块、类或函数中的第一个语句。可以通过对象的 __doc__ 成员访问这些字符串。由 pydoc 自动提取和使用。
1.注释文档 2.查看python模块和函数帮助文档方法
1。注释文档
文档字符串应该这样组织：以一行摘要开头，以句号、问号或感叹号结尾（或者文档字符串应该只有一行）。后面是一个空行，然后是文档字符串的其余部分，应与文档字符串第一行的第一个引号对齐。
#!/usr/bin/env python# -*-coding:utf-8 -*-
#注释.py
'''介绍如何快速生成文档的注释。首先，我们需要使用Py中的__all__属性来导出__all__中的所有类、函数、变量成员等。在模块中使用 __all__ 属性。避免相互引用时出现命名冲突'''
__all__ = [ '登录' , '检查' , '商店' , 'upDateIt' , 'findIt' 、
'删除它'，'创建它']
class Login: ''' 测试注释可以写这样的功能说明等，比如这个方法用来写login''' def __init__ （自身）： '''初始化你想要的参数说明'''
通过 def 检查（自我）： ''' 协商您的功能描述想要实施 ''' pass class Shop: ''' 产品类中包含的属性和方法 update Change/update find find delete delete create add '' def __init__ ( self) : ''' 初始化产品价格、日期、类别等''' pass def upDateIt（自我）： ''' 用于更新产品信息'''
pass deffindIt (自己): '''查找产品信息''' pass def
deleteIt(self : def createIt(self):
'''创建新产品和货架信息''' 通过
if
__name__ == “__main__”
： 导入 注释 打印 帮助（注释）
您可以通过__doc__访问任何函数、类或模块中的文档注释。
1) 访问模块注释
2) 访问类注释
3) 访问功能注释
4) 修改__doc__
此修改不会修改文档内容本身。
2。查看python模块及函数帮助文档方法
这里介绍一下python自带的查看帮助功能，可以在编程过程中不间断地快速找到所需模块和函数的用法。
http://www.sychzs.cn/u013810296/article/details/55509284
帮助（模块名称），查看完整评论
dir（模块名称），查看对象属性
参考文章
1, 如何在python中快速生成注释文档
https://www.sychzs.cn/cookie1026/p/6093188.html
