Using NamespaceDoc and NamespaceGroupDoc Classes

Sandcastle XML Comments

previous page next page
Sandcastle XML Comments Guide Using NamespaceDoc and NamespaceGroupDoc Classes

If your build tool supports it, namespace comments can also be specified and maintained in your source code by adding an empty NamespaceDoc class to each namespace. When comments for this class are found in the XML comments files they will be used as the namespace comments.

To keep the NamespaceDoc class from appearing in the help file, leave off the public keyword and mark it with a CompilerGenerated attribute. This will cause the class to be automatically ignored when reflection information is generated for the assembly. The following is an example:

C#
VB
C++
F#
Copy 
namespace Company.Product.Widgets
{
    /// <summary>
    /// These are the namespace comments for <c>Company.Product.Widgets</c>.
    /// </summary>
    [System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
    class NamespaceDoc
    {
    }
}
Namespace Company.Product.Widgets
    ''' <summary>
    ''' These are the namespace comments for <c>Company.Product.Widgets</c>.
    ''' </summary>
    <System.Runtime.CompilerServices.CompilerGeneratedAttribute()> _
    Class NamespaceDoc
    End Class
End Namespace

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

If the project has namespace grouping enabled, you can also maintain the namespace group comments using a NamespaceGroupDoc class in a similar fashion. The following is an example:

C#
VB
C++
F#
Copy 
namespace Company.Product
{
    /// <summary>
    /// These are the group comments for namespaces in <c>Company.Product</c>.
    /// </summary>
    [System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
    class NamespaceGroupDoc
    {
    }
}
Namespace Company.Product
    ''' <summary>
    ''' These are the group comments for namespaces in <c>Company.Product</c>.
    ''' </summary>
    <System.Runtime.CompilerServices.CompilerGeneratedAttribute()> _
    Class NamespaceGroupDoc
    End Class
End Namespace

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

See Also
previous page start next page