views:

28

answers:

0

Does anyone know if there is an XML comment tag that allows one to hide text from a comment generator (specifically sandcastle)?

For example, given the following:

/// <summary>
/// Returns the sum of two numbers.
/// </summary>
/// <hide>I do not want this text in any documentation generated by sandcastle.</hide>
/// <param name="a">The first number.</param>
/// <param name="b">The second number.</param>
/// <returns>A value representing the sum of two numbers.</returns>
public int Sum(int a, int b)
{
 return a + b;
}

I would like to have the text between the ... tags not show up in any sandcastle generated output.

Any thoughts?