I create documentation for my library using the Sandcastle Help File Builder GUI . All methods, properties, etc. described using XML document comments. But I don’t know how to describe one entity, this is the namespace itself, I can’t find where it is and how to describe it, please help.

enter image description here

    1 answer 1

    A namespace has an empty class called NamespaceDoc, its XML documentation is considered namespace documentation. Also, the [CompilerGenerated] attribute is placed on this class so that it does not get into the documentation itself.

     namespace Some.Test { /// <summary> /// The <see cref="Some.Test"/> namespace contains classes for .... /// </summary> [System.Runtime.CompilerServices.CompilerGenerated] class NamespaceDoc { } }

    http://shfb.codeplex.com/workitem/15516

    If you use Sandcastle Help File Builder, then it has a dialog in the menus for specifying descriptions of namespaces.