Forum: Mikrocontroller und Digitale Elektronik Frage zu Doxygen-Syntax


von zwölferl (Gast)


Lesenswert?

Hi für mein aktuelles µC-Projekt will ich zum 1. mal Doxygen einsetzen.

In einem Buch steht zur Beschreibung des Rückgabewertes einer Funktion:
1
@return

imm www fand ich aber
1
\return

was ist jetzt gültiger (schön wort ;-) bzw. aktueller?
oder sind die gleichwertig?

von Rolf Magnus (Gast)


Lesenswert?

zwölferl schrieb:
> was ist jetzt gültiger (schön wort ;-) bzw. aktueller?
> oder sind die gleichwertig?

Im Handbuch wird fast überall \ verwendet.
Unter "Special Commands" steht dort:

"All commands in the documentation start with a backslash (\) or an 
at-sign (@). If you prefer you can replace all commands starting with a 
backslash below by their counterparts that start with an at-sign."
( http://www.stack.nl/~dimitri/doxygen/commands.html )

Das läßt vermuten, daß sie gleichwertig sind.

von Stefan (Gast)


Lesenswert?

Doxygen unterstützt viele unterschiedliche Schreibweisen parallel. 
Beides ist richtig. Ich bevorzuge die Javadoc Syntax (auch in C 
Projekten), weil ich auch viel in Java programmieren muss.

Bitte melde dich an um einen Beitrag zu schreiben. Anmeldung ist kostenlos und dauert nur eine Minute.
Bestehender Account
Schon ein Account bei Google/GoogleMail? Keine Anmeldung erforderlich!
Mit Google-Account einloggen
Noch kein Account? Hier anmelden.