Doc-To-Help supports all standard XML comment tags, allowing you to easily format text in the XML file used to generate your reference source document. For a complete list of the tags, see the Microsoft documentation.
In additon, Doc-To-Help also supports the non-standard XML comment tags supported by the free tool NDoc. NDoc, like Doc-To-Help, uses .NET assemblies and XML documentation files to automatically generate MSDN-style reference documentation. The non-standard tags supported by NDoc include:
|
<note> |
The <note> tag produces a formatted note block. |
|
<overloads> |
The <overloads> tag provides documentation that applies to all the overloads of a member. |
|
<exclude> |
The <exclude/> tag directs NDoc to exclude the current item from documentation. |
|
<preliminary> |
The <preliminary> tags marks the documentation for the current item as preliminary. |
|
<event> |
The <event> tag describes which events can be raised by the current method. |
|
<threadsafety> |
The <threadsafety> tag is used to describe how a class or structure behaves in multi-threaded scenarios. |