Python Erstellen von Funktionen, an die Sie sich später erinnern können

Was machen Sie mit dieser Funktion, auch wenn Sie sie sich Wochen später ansehen? Wenn ich mich nicht erinnern kann

Sie können einen Kommentar am Anfang der Funktion und eine Beschreibung in das Argument einfügen, um zu erfahren, wie Sie es verwenden und wie Sie es sehen

Beispiel erstellt: https://github.com/KodairaTomonori/Qiita/blob/master/default_module/syntax/function.py

• Herr Knoguchi wies darauf hin, dass wir es korrigiert haben (28.10.2015).

Beispiel: Einfaches Additionsprogramm

comennt.py

def addition(num_a: int, num_b: int, flag:bool=True) -> int:
    '''
Diese Funktion ist num_a + num_Ein Programm, das berechnet und zurückgibt b.
Wenn das Flag auf True gesetzt ist, wird das Ergebnis zur einfachen Anzeige gedruckt.
    '''
    if flag: print('{} + {} = {}'.format(num_a, num_b, num_a + num_b) )
    return num_a + num_b

if __name__ == '__main__':
    result = addition(1234, 4321)
    print('result:', result) 
    print('Argumentinformationen: ', addition.__annotations__)
    print('Bedienungsanleitung: ', addition.__doc__)

Ausgabe

output.txt

1234 + 4321 = 5555
result: 5555
Argumentinformationen:  {'num_b': <class 'int'>, 'num_a': <class 'int'>, 'return': <class 'int'>, 'flag': <class 'bool'>}
Bedienungsanleitung:  
Diese Funktion ist num_a + num_Ein Programm, das berechnet und zurückgibt b.
Wenn das Flag auf True gesetzt ist, wird das Ergebnis zur einfachen Anzeige gedruckt.

Kommentar

Die Funktion "Addition" selbst ist ein Programm, das eine einfache Addition ausführt. Wenn Sie "Flag" auf "Falsch" setzen, wird nur das Ergebnis zurückgegeben.

Geben Sie eine Beschreibung in die Funktion ein

Wenn Sie eine Beschreibung in das Argument einfügen möchten, (num_a: int, num_b: int, flag:bool=True) -> int Ich werde wie ein Wörterbuch schreiben. Argumentname links, Typ rechts (Argument: Typ), und wenn Sie einen Standardwert angeben möchten, fügen Sie am Ende einfach so etwas wie = True hinzu. Schließlich können Sie den Rückgabetyp auch mit -> int eingeben.

Sie können sehen, wie Sie auf diese Argumentation verweisen, indem Sie "Addition .__ Annotations__" setzen.

Wenn Sie eine Beschreibung in eine Funktion einfügen, können Sie eine Zeichenfolge an die nächste Stelle setzen, die durch "def" deklariert wurde. Sie können sehen, wie Sie auf diese Erklärung verweisen, indem Sie "Addition .__ doc__" verwenden.

Zusammenfassung

Es ist wichtig, den Argumentnamen leicht verständlich zu machen, auch wenn Sie ihn später betrachten. Es wird jedoch einfacher, ihn zu verstehen, wenn Sie eine Beschreibung hinzufügen. Daher werde ich ihn von nun an problemlos schreiben.