Wie xml-Kommentar für doxygen/doc über namespace platzieren?

20/03/2008 - 11:25 von Susanne Klemm | Report spam
Hallo,

Ich möchte mit doxygen die Hilfe fà¼r mein Projekt erstellen. Dazu habe ich
à¼ber dem Namensraum ebenfalls ein <summary>-Tag, der von Doxygen auch
korrekt ausgewertet wird. Allerdings meckert der Compiler mit CS1587, dass
à¼ber dem namespace kein xml-Kommentar stehen darf:

/// <summary>Test</summary>
namespace Test
{
...
}

Gibt es ein Workaround, wie ich trotzdem die Namensraumbeschreibung in meine
Doku bekomme?


// <summary>Test</summary>
namespace Test
{
...
}

und


namespace Test //< Test
{
...
}

funktionieren zumindest nicht mit Doxygen.

Danke im Voraus!
Susanne
 

Lesen sie die antworten

#1 Frank Dzaebel
20/03/2008 - 12:07 | Warnen spam
Hallo Susanne,

Ich möchte mit doxygen die Hilfe für mein Projekt erstellen.



Ich selber würde eher Microsofts freies SandCastle nehmen, aber ok.


Dazu habe ich über dem Namensraum ebenfalls ein
<summary>-Tag, der von Doxygen auch korrekt ausgewertet
wird. Allerdings meckert der Compiler mit CS1587, dass
über dem namespace kein xml-Kommentar stehen darf:



Nun, das ist auch richtig, ein XML Kommentar ist da nicht erlaubt.
Kenne mich bei doxgen nicht aus, aber versuche einmal:

/*!amespace Meine Beschreibung des Namensraums
*/
namespace MyNameSpace
{

}


Ein Versuch ist's wert.
Alternativ kann man die Warning ggf. ausschalten:

[/nowarn (Angegebene Warnungen unterdrücken) (C#)]
http://msdn2.microsoft.com/de-de/library/7f28x9z3(VS.80).aspx


ciao Frank
Dipl.Inf. Frank Dzaebel [MCP/MVP C#]
http://Dzaebel.NET

Ähnliche fragen