doxygen Syntax

welcher Tag style in C++ Kommentaren ist besser hinsichtlich Zukunftssicherheit und Portabilität:

\param 
@param

Und was ist in der Summe aller Eigenschaften überhaupt vorzuziehen - javadoc oder doxygen?

supertux

solange doxygen beide unterstützt, dann ist es egal, wobei ich eher auf \param zugreife (damit es nicht so javaisch aussieht).

Wenn ich java programmieren würde, dann würde ich auf jeden Fall javadoc nehmen, aber für C, C++ ist mir doxygen lieber.

aha. Nein, ist C++. Also doxygen mit @param-Syntax, das müßte dann mit beidem kompatibel sein.

Eindeutig \param.

So kommentiere ich mit Doxygen:

/// Kurzbeschreibung
/** Langbeschreibung.
\param a darum
\since 1.0 */
void foo(int a);

Alles andere ist Verrat an der C++-Kultur!

ich habe mich gerade heute morgen vorerst einmal für

/**
 *  Kurzbeschreibung.
 *
 *  Langbeschreibung.
 *
 *  @param a darum
 *  @return bla 
 */
void foo(int a);

entschieden -

- ich habe solche Unmengen an TeX code gesehen, da stören mich \param und \return in einem C++ Programm irgendwie reflexartig

^^na, wenigstens brauchste bei doxygen kein html <p>absatz</p> usw. von hand rein zu hacken, so wie bei javadoc.

vlad_tepesch

ich handhabe es meistens so, dass ich für praragraphbildene keys (details, brief, param, return, file) ein @ benutze, weil das so schön ins auge springt und innerhalb von Text zur froamtierung dann das \ benutze.

DaRpH

Ich würde den XML Stil nehmen hab zumindestens irgendwo gelesen das im neuem VS10 der auch dann direkt in der IDE unterstützt wird.

Leider kann man mit dem XML Stil noch nicht alles in doxygen machen is nur der kleinste gemeinsame nenner

Ganz klar Javadoc-Syntax springt deutlich besser ins Auge als die \-Notation (ist imho auch klar \ ist ja viel weniger verschnörkelt als ein @).