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):
        '''
        查找商品信息
        '''
        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外面,这样也是没显示效果
的。