So generieren Sie schnell Anmerkungsdokumente in Python

So generieren Sie schnell Annotationsdokumente in Python

Heute erzähle ich Ihnen ein einfaches kleines Detail, auf das Sie nur achten müssen. Sie können ganz einfach Annotationsdokumente generieren und auch überprüfen, ob es welche gibt Doppelte Namen der von uns geschriebenen Klassenmethodenreferenzen warten. Wenn Sie sich die Dokumentation anderer professioneller Experten ansehen, werden Sie neidisch sein. Erstens können wir die Lesbarkeit des Codes insgesamt verbessern Die Gesamtstruktur des Codes ist außerdem klarer, was bei der Übergabe viel Ärger ersparen kann. Wenn andere Kollegen Ihre Arbeit übernehmen, werden Sie nicht zeilenweise gefragt, was das ist und was das ist, da die Kommentare vorhanden sind In der Integration kann es manchmal als Beschreibungsdokument verwendet werden, um Kunden kurze Anweisungen zu geben. Dann kommen wir zum Punkt, wie man es implementiert dass der Kommentarort sowie der Funktionsname und der Klassenname alle mit __all__ zusammenhängen

#!/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 pythonzhushi
    print help(pythonzhushi)

Es sollte hier betont werden, dass der Name von py mit dem Namen des py identisch sein muss, an dem Sie gerade arbeiten (Der Name des py, den ich hier erstellt habe, ist pythonzhushi, und der endgültige Import ist auch dieser Name), da im folgenden Test import Daher ist der Import selbst, der Importname und die Hilfe (Name) sowie Ihr Dateiname müssen sein konsistent. Um es intuitiver zu machen, schauen Sie sich bitte das Bild unten an:

Natürlich können Sie auch aus anderen Dateireferenzen importieren. Hier verwenden wir die allgemeine Importmethode von Python Verzeichnis zum Importieren, welche Datei importiert werden soll Damit wir auch die Anmerkungsdokumente importieren können, die wir benötigen, hilft die Hilfehilfemethode dabei, ein einfaches Hilfedokument anzuzeigen, das uns hilft, die in dieser Datei enthaltenen Klassen und Funktionen anzuzeigen, ähnlich einer Beschreibung eines Readme-Dokuments. Werfen wir abschließend einen Blick auf den Maskierungseffekt:

Ist es möglich, die Anleitung unseres Programms einfach auszudrucken? Sie können dies in den folgenden Schritten direkt in den Text einfügen, um die Dokumentbeschreibung einer Readme-Datei zu vervollständigen. Nach dem Testen sind einige Punkte zu beachten. Wenn Sie einen Kommentar wie # schreiben möchten, schreiben Sie ihn nicht in die Def release, aber schreiben Sie es an die Position darüber, was dem Dekorator ähnelt. Im Gegenteil, drei. Schreiben Sie die Anführungszeichen ''' nicht außerhalb von def, da dies keinen Anzeigeeffekt hat. Beeilt euch alle und probiert es aus. Danke fürs Zuschauen. .