Analysieren des Python-Code-Kommentarspezifikationscodes

span>

1 Einführung in Codekommentare

• Kommentare sind Erläuterungen zum Code und Beschreibungen, deren Zweck darin besteht, es den Menschen leichter zu machen, den Code zu verstehen.
• Kommentare sind, wenn der Programmierer eine Erklärung oder einen Hinweis für eine Anweisung, ein Programmsegment, eine Funktion usw. schreibt, was die Lesbarkeit des Programmcodes verbessern kann.

• In Codes mit Verarbeitungslogik muss der Anteil der effektiven Kommentare im Quellprogramm mehr als 20 % betragen.

Verwandte Lernempfehlungen: Python Video-Tutorial

2. Klassifizierung von Codekommentaren

Zeilenkommentare: Die Zeile nach dem Symbol wird nicht kompiliert (angezeigt)

Blockkommentare: Der Teil in der Mitte des blockkommentierten Symbols wird nicht kompiliert

3. Grundlagen von Python-Codekommentaren

# wird in Python verwendet, um einzeilige Kommentare darzustellen . Einzeilige Kommentare können als separate Zeile über der zu kommentierenden Codezeile oder nach einer Anweisung oder einem Ausdruck platziert werden. Das folgende Beispiel:

name = 'xiaohong' # Einzeiliger Kommentar

# Einzeiliger Kommentar
name = 'xiaohong'

blockquote>

Verwenden Sie in Python drei einfache Anführungszeichen oder drei doppelte Anführungszeichen, um mehrzeilige Kommentare anzuzeigen. Wird verwendet, wenn zu viele Kommentare zum Schreiben vorhanden sind, wie im folgenden Beispiel:

'''
Dies ist ein mehrzeiliger Kommentar mit drei einfachen Anführungszeichen
'''

"""
Dies ist ein mehrzeiliger Kommentar mit drei doppelten Anführungszeichen
""

4. Einführung und Verwendung von DocStrings

4.1 Einführung in DocStrings

Dokumentzeichenfolgen p>

ist ein wichtiges Werkzeug zum Interpretieren von Dokumentationsprogrammen und trägt dazu bei, dass Ihre Programmdokumentation einfacher und verständlicher wird.

4.2 Verwendung von DocStrings in Python

Verwendung im erste Zeile des Funktionskörpers Ein Paar aus drei einfachen Anführungszeichen „“ oder ein Paar aus drei doppelten Anführungszeichen „“ zur Definition der Dokumentzeichenfolge. Sie können doc (beachten Sie den doppelten Unterstrich) verwenden, um das Docstring-Attribut in der Funktion aufzurufen.

Schreibbeispiel wie folgt:

def add(num1,num2):
  """ 完成传入的两个数之和

  :param num1: 加数1
  :param num2: 加数2
  :return: 和
  """
  return num1 + num2

print( add.__doc__ )

Hinweis: DocStrings dokumentiert die Verwendungskonvention für Zeichenfolgen: Die erste Zeile beschreibt kurz die Funktion, die zweite Zeile ist leer und die dritte Zeile enthält eine spezifische Beschreibung der Funktion.

5. Häufig verwendete Schreibstile für DocStrings

5.1 reST-Stil

Dies ist jetzt ein beliebter Stil. Ein Stil, reST-Stil, das Standardformat von Sphinx, relativ kompakt.

"""
This is a reST style.

:param param1: this is a first param
:param param2: this is a second param
:returns: this is a description of what is returned
:raises keyError: raises an exception
"""

5.2 Google-Stil

"""
This is a groups style docs.

Parameters:
 param1 - this is the first param
 param2 - this is a second param

Returns:
 This is a description of what is returned

Raises:
 KeyError - raises an exception
"""

5.3 Numpydoc (Numpy-Stil)

"""
My numpydoc description of a kind
of very exhautive numpydoc format docstring.

Parameters
----------
first : array_like
 the 1st param name `first`
second :
 the 2nd param
third : {'value', 'other'}, optional
 the 3rd param, by default 'value'

Returns
-------
string
 a value in a string

Raises
------
KeyError
 when a key error
OtherError
 when an other error
"""

Einige Kommentare

• Für Code, der klar ist Auf einen Blick müssen keine Kommentare hinzugefügt werden.
• Bei komplexen Operationen sollten entsprechende Kommentare geschrieben werden, bevor die Operation beginnt.
• Bei Code, der nicht selbsterklärend ist, sollten Kommentare geschrieben werden nach dem Code hinzugefügt werden.
• Beschreiben Sie niemals den Code. Im Allgemeinen verstehen Leute, die Code lesen, die Syntax von Python, aber sie wissen einfach nicht, was der Code tut.

Verwandte Lernempfehlungen: Programmiervideo

Das obige ist der detaillierte Inhalt vonAnalysieren des Python-Code-Kommentarspezifikationscodes. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!