Was sind die gängigsten Python-Docstring-Formate?

Es gibt mehrere gängige Formate für Python-Docstrings, darunter:

  1. Das "One-Liner"-Format, bei dem es sich um eine einzeilige Textzeile handelt, die die Funktion oder Klasse kurz beschreibt. Beispiel:
def meine_funktion():
    """Diese Funktion tut etwas."""
  1. Das "epytext"-Format, das eine Markup-Sprache ist, die verwendet werden kann, um strukturierte Dokumentation zu erstellen. Beispiel:
def meine_funktion(arg1, arg2):
    """
    Diese Funktion tut etwas.

    @param arg1: Das erste Argument.
    @param arg2: Das zweite Argument.
    @return: Das Ergebnis der Funktion.
    """
  1. Das "reStructuredText"-Format, das eine Markup-Sprache ist, die ähnlich wie epytext ist, aber weit verbreitet in der Python-Dokumentation verwendet wird. Beispiel:
def meine_funktion(arg1, arg2):
    """
    Diese Funktion tut etwas.

    :param arg1: Das erste Argument.
    :param arg2: Das zweite Argument.
    :return: Das Ergebnis der Funktion.
    """
  1. Numpy/Google format
def meine_funktion(arg1, arg2):
    """
    Diese Funktion tut etwas.
    
    Parameter
    ----------
    arg1 : int
        Das erste Argument.
    arg2 : int
        Das zweite Argument.
        
    Gibt zurück
    -------
    int
        Das Ergebnis der Funktion.
    """

Es ist wichtig zu beachten, dass das am häufigsten verwendete Format das Numpy / Google-Format ist, das in wissenschaftlichen und Datenwissenschaftsgemeinschaften weit verbreitet ist.