Frage zu Doxygen-Syntax

Gast #2962957
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?
Gast #2962980
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.
Gast #2963403
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.

Antwort schreiben

Eine eigene Frage? Dieser Thread ist über 13 Jahre alt. Stell sie in einem eigenen Thread – dort lesen mehr Leute mit, und sie wird öfter und schneller beantwortet.

Neuen Thread starten

Eine Lösung, Ergänzung oder Rückmeldung zu diesem Thread? Dann antworte hier.

Formatierung
  • [c]C-Code[/c]
  • [code]Code in anderen Sprachen, ASCII-Zeichnungen[/code]
  • [math]Formel in LaTeX-Syntax[/math]
  • [[Titel]] – Link zu einem Artikel
  • Verweis auf einen anderen Beitrag: Rechtsklick auf dessen Beitrags-ID (#8078628), „Adresse kopieren“, in den Text einfügen

Mehr zur Formatierung

Längeren Sourcecode als Anhang, nicht in den Text. JPG nur für Fotos und Scans; Zeichnungen und Screenshots als PNG oder GIF. Siehe Bildformate.

Schon registriert? Anmelden

Wird nicht angezeigt. Wir schicken dir einen Link; sobald du damit bestätigst, erscheint dein Beitrag.

Mit dem Abschicken legst du einen kostenlosen Account an und erkennst die Nutzungsbedingungen und die Datenschutzerklärung an.