Come ignorare la documentazione generata dal Generatore di file della Guida per Public Class o Methods?

Question

Come posso omettere determinate classi o metodi pubblici dall'essere inclusi nella documentazione generata da The SandCastle Help File Builder?

Esempio: Ho il seguente classe pubblica con due metodi pubblici:

/// <summary> 
/// A simple test class. 
/// </summary> 
public class MyClass 
{ 
    /// <summary> 
    /// Method1s this instance. 
    /// </summary> 
    public void Method1() 
    { 
     // Do some operations here. 
    } 

    /// <summary> 
    /// Method2s this instance. 
    /// </summary> 
    public void Method2() 
    { 
     // Do some operations here. 
    } 
} 

Quando ho generare il file della Guida da questo codice usando SandCastle file di aiuto Builder, voglio ignorare Method2.

Answer 1

Nelle proprietà del progetto nella GUI della Guida di File Builder di Sandcastle, modificare la proprietà ApiFilter (fare clic sul pulsante "...") e deselezionare i membri che non si desidera visualizzare nel file della guida.

Answer 2

(Questo è un aggiornamento, dal momento che l'interfaccia utente sembra essere cambiato da quando Thomas Levesque ha pubblicato il suo commento. E 'anche diverso da alcune informazioni che ho trovato on-line altri posti.)

Nella versione più recente di SandCastle , al 31 maggio 2014, devi passare 3 passaggi per arrivarci.

1. In stand-alone interfaccia utente, selezionare la schedaproprietà del progetto.
2. Ci dovrebbe essere un elenco di categorie sulla sinistra. Selezionare Visibilità
3. Fare clic sul pulsante Modifica filtro API; questo è in fondo al da sul lato destro.

Da lì, troverete l'elenco delle voci API. È possibile deselezionare singolarmente classi, spazi dei nomi e elementi all'interno di una classe (proprietà, campi, metodi).