Menu
I understand that if you /// above a class, field, method, or property Visual Studio will start establishing XML-style comments for you.
However, where can I go to add XML comments for my namespaces and/or library...
For example:
I'm not sure if those pages were manually created or if they were automatically created via XML-style comments being added in the proper locations?
453
An XML comment encountered outside the document type declaration is represented by the Comment value syntax element. It contains the comment text from the XML message. If the value of the element contains the character sequence --> , the sequence is replaced with the text --> .
To insert XML comments for a code element Type /// in C#, or ''' in Visual Basic.
C# documentation comments use XML elements to define the structure of the output documentation. One consequence of this feature is that you can add any valid XML in your documentation comments. The C# compiler copies these elements into the output XML file.
That depends on the tool you use to generate your documentation. With NDoc, I believe, you simply had to create a class called NamespaceDoc inside the namespace you wanted to document. The XML-Comment of that class would have then be used.
Since the question is tagged with "sandcastle", I assume you are indeed using it. If so, this SO answer should give the details.
Update: OK, I just (in that same thread) saw that apparently Sandcastle understands NamespaceDoc-classes as well. Somebody might want to close this question as a duplicate.
71
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
