Eure favorisierte Form der Dokumentation

[Valle]

Wir verwenden Python, daher bin ich hier vielleicht etwas außenvor.

Python unterstützt Dokumentation als Teil der Sprache. Packages, Klassen und Methoden können jeweils mit einem String beginnen, der die Dokumentation beinhaltet. Es existieren entsprechende Tools um das dann in beliebige andere Dateiformate umzuwandeln. Bei uns klappt das eigentlich ganz gut.

Hier mal ein Beispiel, für die, die sowas noch nicht gesehen haben:

Code:

"""
My Module

>>> inline_code_example()
"""
 
class Foo:
    """
    My Class
    """
 
    def __init__(self):
        """
        My Constructor
        """
        pass
 
    def add(self, a, b):
        """
        Returns ``a`` + ``b``
        """
        return a + b