Mal 'ne frage
-
Für was brauche ich solche Sachen? Ist das überhaupt C++ spezifisch?
@author @param
-
Wo hast du denn sowas gefunden? Ich kenne das nur im Zusammenhang mit doxygen-Kommentaren.
-
In Comments sind dies meistens Angaben für Programme, die dir Dokumentationen aus deinem Code erzeugen (Doxygen z.b.)
-
Unter anderem habe ich das in der STL gefunden (mingw). Code::Blocks hat auch die möglichkeit, solche Schlüsselworte speziell einzufärben. Das bezieht sich also nur auf das Dokumentationstool namens Doxygen?
/** * This is a documentation comment block * @param xxx does this (this is the documentation keyword) * @authr some user (this is the documentation keyword error) */
-
Stefan schrieb:
Für was brauche ich solche Sachen? ...
Wie schon gesagt handelt es sich hier um Doxygen-Tags, und die haben an sich mit C++ nichts zu tun, sondern dienen der Codedokumentation. Ob du sie brauchst ist wiederum eine andere Frage, lies dir hierzu ggf. mal eine doxygen-Beschreibung durch.
http://www.stack.nl/~dimitri/doxygen/
Doxygen oder vergleichbare Codedokumentationstools haben durchaus ihren Berechtigungssinn.
cu André
-
Es handelt sich eigentlich um Javadoc Tags, die Doxygen ebenfalls versteht. Ich benutze immer die Doxygen-Tags:
/// Eine kurzer Beschreibungstext für foo. /** Ein langer und detailierter Beschreibungstext für foo. \param a Ein Parameter \author Artchi \since 1.0 */ void foo(int a);
-
Dieser Thread wurde von Moderator/in HumeSikkins aus dem Forum C++ in das Forum Rund um die Programmierung verschoben.
Im Zweifelsfall bitte auch folgende Hinweise beachten:
C/C++ Forum :: FAQ - Sonstiges :: Wohin mit meiner Frage?Dieses Posting wurde automatisch erzeugt.
-
@__Stefan__
benutz bitte sinnvolle Überschriften!
So etwas wie "Was bedeutet @author in Kommentare" wäre doch wesentlich sinniger gewesen, nich?Hier ist das doxygen Ergebnis für die libstdc++: http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/
-
Nicht zu verwechseln mit Java-Annotationen.
