XML-Kommentare für C++

dEUs

Hallo zusammen,

Visual Studio generiert für C# ja automatisch XML-Kommentare, wenn man vor einer Methode 3 Slashes eingibt:

/// <summary>
        /// 
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>

Bei C++ funktioniert das nicht. Gibt es ein AddIn für Visual Studio 2008 das diese Funktionalität nachrüstet?
Für Visual Studio 2005 habe ich eines gefunden das ok wäre, leider funktioniert es mit Visual Studio 2008 nicht
http://www.codeplex.com/NetDocumentor
Kennt ihr noch andere?

Danke!

Jochen Kalmbach

Ich dachte das geht mit VS2008 schon automatisch...

Siehe: /doc (C++)
http://msdn.microsoft.com/en-us/library/ms173501.aspx
(ach so... aber vermutlich nur für "ref" Klassen hab es aber nicht getestet... hab von dieser Einschränkung aber nirgendwo gelesen; nur die Intellisense würde es wohl nicht unterstützen)

Recommended Tags for Documentation Comments (Visual C++)
http://msdn.microsoft.com/en-us/library/ms177227.aspx

dEUs

Hi Jochen,

klar gibt es die auch bei C++. Aber sie werden nicht automatisch erstellt! Ich meine nicht das Erstellen einer Dokumentationsdatei während dem Kompiliervorgang sondern eben das Erstellen der Kommentare selbst im Quelltext. So wie ich es eben beschrieben habe: Bei C# werden die automatisch erstellt, wenn man 3 slashes hintereinander tippt.

Martin Richter

Wenn ich drei slashes tippe,dann kommt bei mir automatisch ein VA-Snippet aus Visual Assit

dEUs

Ist dieses Snippet kontextbezogen oder statisch?

Martin Richter

/// ist statisch.

Für dynamisches einfügen benutze ich die Refactor Document Methode!
http://www.wholetomato.com/products/features/vasnippets.asp
Siehe Abschnitt Refactor...

dEUs

Kann das das, was ich brauche? Sieht für mich nicht danach aus...

Martin Richter

dEUs schrieb:

Kann das das, was ich brauche? Sieht für mich nicht danach aus...

Was meinst Du? Du kannst doch selber definieren, was dann für ein Codeblock eingesetzt wird...

dEUs

Ja, aber der Codeblock soll ja abhängig vom Kontext sein und so wie ich das sehe, habe ich da keinen Zugriff auf die einzelnen Parameter, bzw nur als Komma-separierte Liste.

hustbaer

@deus: VAX wiederholt soweit ich mich erinnere einfach alle Zeilen in denen man ein Makro verwendet welches sich auf ein Parameter bezieht.
Also du schreibst z.B.:

// lalala
// blablubb
// parameters:
//  * $paramType$ $paramName$: ...
// ende

und dann kommt raus:

// lalala
// blablubb
// parameters:
//  * int foo: ...
//  * char bar: ...
//  * float baz: ...
// ende

Zieh dir VAX einfach mal. Gibt ja ne "Trial-Period", und das Ding ist schnell wieder deinstalliert wenns dir nicht gefällt.

EDIT: die Makro-Namen ( $paramType$ ) sind frei erfunden, weiss nicht auswendig wie die genau heissen, aber geht ja nur ums Prinzip /EDIT

dEUs

Hallo zusammen,

ja, VAX kann das!

Danke!