Erste Dokumentationskommentare

Bereits von Anfang an spielte ich mit dem Gedanken, mit dem Programm vjassdoc auch Dokumentationskommentare, welche in anderen Sprachen normalerweise zwischen den /**-*/-Zeichen eingeschlossen werden, zu unterstützen.

Bei vjassdoc werden es allerdings anfangs nur einzeilige Kommentare mit dem ///-Präfix sein, da Jass bzw. vJass auch nur solche unterstützt und vjassdoc den Code nur interpretieren und nicht verändern soll.

Folgt diesem Präfix nun Text, so wird der Text gespeichert und dem nächsten ausgewerteten Objekt als Beschreibung zugeordnet.
Natürlich gibt es auch entsprechende Schlüsselwörter, die bestimmte Eigenschaften des Objekts beschreiben. Zunächst sollen folgende unterstützt werden:

  • @arg: Die Beschreibung eines Methoden- bzw. Funktionsarguments.
  • @author: Der Autor des Objekts.
  • @return: Die Beschreibung eines Rückgabewerts einer Methode oder Funktion.
  • @todo: Ein Hinweis, was beim Objekt noch zu tun ist.

Außerdem soll es einige Schlüsselwörter geben, die speziell auf Warcraft bzw. vJass zugeschnitten sind. Welche das sein werden, werde ich hier noch nicht bekannt geben, weil es noch nicht wirklich feststeht.
Es gilt noch anzumerken, dass sich die Beschreibungen in der API-Dokumentation ausschließlich aus diesen Kommentaren ergeben.

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: