Python快速⽣成注释⽂档Python为我们⽣成基本满⾜的说明⽂档，⼀来可以提⾼代码整体阅读性，⼆来可以将代码的整体结构看着也更清晰。注意：注释的地⽅和函数名类名都是与__all__内相关联的
简单的代码格式：
#!/usr/bin/env python
# -*-coding:utf-8 -*-
'''
⽂档快速⽣成注释的⽅法介绍,⾸先我们要⽤到__all__属性
在Py中使⽤为导出__all__中的所有类、函数、变量成员等
在模块使⽤__all__属性可避免相互引⽤时命名冲突
'''
__all__ = ['Login', 'check', 'Shop', 'upDateIt', 'findIt', 'deleteIt', 'createIt']
class Login:
'''
测试注释⼀可以写上此类的作⽤说明等
例如此⽅法⽤来写登录
'''
def__init__(self):
'''
初始化你要的参数说明
那么登录可能要⽤到
⽤户名username
密码password
'''
pass
def check(self):
'''
协商你要实现的功能说明
功能也有很多例如验证
判断语句，验证码之类的
'''
pass
class Shop:
'''
商品类所包含的属性及⽅法
update改/更新
find查
delete删除
create添加
'''
def__init__(self):
'''
初始化商品的价格、⽇期、分类等
'''
pass
def upDateIt(self):
'''
⽤来更新商品信息
'''
pass
def findIt(self):
'''
查商品信息
'''
python中文文档pass
def deleteIt(self):
'''
删除过期下架商品信息
'''
pass
def createIt(self):
'''
创建新商品及上架信息
'''
pass
if__name__=="__main__":
import PythonAnnotation
print(help(PythonAnnotation))
强调说明下py的名字要和你当前⼯作的py名字⼀样(我这⾥创建的py名字就是PythonAnnotation，最后导⼊也是这名字)，因为下⾯的测试中import的导⼊的是⾃⾝所以,import 名称和Help(名称)以及你的⽂件名称要⼀致才可以。
为了更加直观请看下⾯这图：
测试效果：
是不是⼀⽬了然，这样也可以导⼊我们需要做的注释⽂档，help帮助⽅法就是帮我们查看到此⽂件中所包含的类，函数，的⼀个简单帮助⽂档，类似于readme⽂档的⼀个说明
# 经过测试有⼏点注意：想要写#这种注释不要写到def⽅法内要写到它的上⾯位置和装饰器类似，相反三引号'''不要写到def外⾯，这样也是没显⽰效果
的。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。