The MSDN and VS.NET documenters that ship with NDoc3 use a number of custom attributes to augment the code comment tags when generating documentation.
When a type or member is decorated with the attributes described below, NDoc3 will use this information in order to make the help file more descriptive.
| Attribute | Comments |
|---|---|
|
Marks program elements that are no longer in use. NDoc3 will include warning text for each item that is marked as obsolete. |
|
Indicates that an enumeration can be treated as a bit field; that is, a set of flags. NDoc3 enhances the documentation as follows,
|
|
|
This attribute prevents types of members from showing up in editor or type browsers. If the project setting EditorBrowsableFilter is set to true, then no documentation will be generated for items decorated with this attribute. The <exclude/> tag is the preferred mechanism for suppressing the documentation of types or members. |
|
|
If the IncludeAssemblyVersion project setting is true, then the assembly version will be included on each topic page. |