Come commentare i namespace in SandCastle

Scritto da  Angelo Stefani il domenica 31 luglio 2011  •  Linguaggio:    • Livello: 100


Utilizzando il tag XML <summary> possiamo commentare i namespace del nostro codice ma SandCastle lo ignora bellamente.
Per poter comunque generare una documentazione di progetto che abbia i giusti commenti per i namespace si può utilizzare il seguente stratagemma:

  1. Creare un file di codice (ad esempio con il nome NamespaceDoc.vb) in un punto qualsiasi del progetto da documentare (ad esempio nella root);
  2. Inserire all'interno del file una classe NamespaceDoc per ogni namespace da documentare decorata con l'attributo CompilerGenerated (in modo da non essere utilizzabile nel codice). Ad esempio supponiamo di avere due namespace MioNamespace.Namespace1 e MioNamespace.Namespace2:

 VB.NET

Namespace MioNamespace.Namespace1

    ''' <summary>

    ''' Commento su Namespace1

    ''' </summary>

    ''' <remarks></remarks>

    <System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)> _

    <System.Runtime.CompilerServices.CompilerGenerated()> _

    Friend Class NamespaceDoc

        Private Sub New()

 

        End Sub

    End Class

End Namespace

 

Namespace MioNamespace.Namespace2

    ''' <summary>

    ''' Commento su Namespace2

    ''' </summary>

    ''' <remarks></remarks>

    <System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)> _

    <System.Runtime.CompilerServices.CompilerGenerated()> _

    Friend Class NamespaceDoc

        Private Sub New()

 

        End Sub

    End Class

End Namespace


Tags: SandCastle,Documentazione

 
x