¿Cómo ignorar la documentación generada por el generador de archivos de Ayuda para Clase Pública o Métodos?

Question

¿Cómo puedo omitir que se incluyan ciertas clases o métodos públicos en la documentación generada por The SandCastle Help File Builder?

Ejemplo: Tengo la siguiente clase pública con dos métodos públicos:

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

Cuando genero el archivo de ayuda de este código usando SandCastle Archivo de Ayuda del constructor, quiero ignorar Method2.

Answer 1

En las propiedades de su proyecto en la GUI de Sandcastle Help File Builder, edite la propiedad ApiFilter (haga clic en el botón "...") y desmarque los miembros que no desea ver en el archivo de ayuda.

Answer 2

(Esto es una actualización, ya que la interfaz de usuario parece haber cambiado desde que Thomas Levesque logró su comentario. También es diferente de alguna información que he encontrado otros lugares en línea.)

En la última versión del SandCastle , a partir del 31 de mayo de 2014, debe realizar 3 pasos para llegar allí.

1. En la interfaz de usuario independiente, seleccione las propiedades del proyecto pestaña.
2. Debe haber una lista de categorías a la izquierda. Seleccione Visibilidad
3. Haga clic en el botón Editar API Filtro; esto está en la parte inferior del del lado derecho.

A partir de ahí, encontrará la lista de entradas de la API. Puede anular la selección individual de clases, espacios de nombres y elementos dentro de una clase (propiedades, campos, métodos).