NDoc User's Guide NDoc 1.3

Attributes supported by NDoc

[This is preliminary documentation and subject to change]

The MSDN and VS.NET documenters that ship with NDoc 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, NDoc will use this information in order to make the help file more descriptive.

Attribute Comments


Marks program elements that are no longer in use.

NDoc 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.

NDoc enhances the documentation as follows,

  • A standard sentence is added after the summary section.

    "This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values."

  • An additional column is added to the member table to document the underlying value of each enumeration member.


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.

As of version 1.3 of NDoc, 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.