Wie kann ich die Dokumentation ignorieren, die vom Hilfedatei-Generator für die öffentliche Klasse oder Methoden generiert wird?

Question

Wie kann ich bestimmte öffentliche Klassen oder Methoden aus der Dokumentation von SandCastle Help File Builder ausschließen?

Beispiel: Ich habe folgende öffentliche Klasse mit zwei öffentliche Methoden haben:

/// <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. 
    } 
} 

Wenn ich die Hilfedatei aus diesem Code Sandcastle Help File Builder erzeugen, möchte ich Method2 ignorieren.

Answer 1

Bearbeiten Sie die Eigenschaft ApiFilter in Ihren Projekteigenschaften in der Sandcastle Help File Builder-GUI (klicken Sie auf die Schaltfläche "..."), und deaktivieren Sie die Elemente, die in der Hilfedatei nicht angezeigt werden sollen.

Answer 2

(Dies ist ein Update, da die UI geändert zu haben scheint seit Thomas Levesque seinen Kommentar geschrieben. Es ist als ein paar Informationen auch anders ich an anderen Orten online gefunden haben.)

In der neuesten Version von Sandcastle Ab dem 31. Mai 2014 müssen Sie 3 Schritte durchlaufen, um dorthin zu gelangen.

1. In der Standalone-UI, wählen Sie die Registerkarte Eigenschaften Projekt.
2. Es sollte eine Liste von Kategorien auf der linken Seite sein. Wählen Sie Sichtbarkeit
3. Klicken Sie auf die Schaltfläche API-Filter bearbeiten Schaltfläche; Das ist unten auf der rechten Seite.

Von dort finden Sie die Liste der API-Einträge. Sie können Klassen, Namespaces und Elemente innerhalb einer Klasse (Eigenschaften, Felder, Methoden) einzeln deaktivieren.