Lx: Quelltext und Dokumentation sind eine Einheit

In Rubisco Lx sind Quelltext und API-Dokumentation eine Einheit.

public filehandle open - Open file

    description
	Open the file with the given filename and mode.

    arguments
        string $filename
            Name of the file to open.
            
        string $mode = 'rb'
            Mode in which the file should be opened.

Es gibt also keine Trennung zwischen Deklaration und der darüber im Doc-Kommentar liegenden Beschreibung der Parameter, sondern beides steht direkt zusammen. Ich benutzte das schon seit ein paar Jahren in meinen PHP-Preprozessor und das funktioniert sehr gut.

Abgeleitet ist das von den Autodocs des AmigaOS die dann bei AROS zusätzlich geschickt mit C-Kommentarzeichen versehen sind, so dass auch bei AROS kein doppeltes Schreiben der Parameternamen nötig ist.

[Direktlink]