2010-04-05 13 views
5

¿Cómo agregar < (menos) o> (mayor que) a un comentario de resumen en Visual Studio? Estoy en Visual Studio 2008.¿Cómo agregar una etiqueta a < or > resumen en el estudio visual?

Tengo un método genérico:

public bool IsMemberProtected<T>(Expression<Func<T, object>> expression) 

encantaría tener una etiqueta resumen de algo como esto

/// <summary> 
    /// Determines whether a member is protected. 
    /// 
    /// Usage: IsMemberProtected<ExampleType>(x => x.Member) 
    /// </summary> 

Pero cuando lo haga eso, la información sobre herramientas para la propiedad ya no funciona cuando un desarrollador se desplaza sobre el método en el código para ver la etiqueta de resumen.

¿Pensamientos?

Respuesta

10

Puede usar las entidades &lt; y &gt; para dar < y > respectivamente.

Observe que aquí también utiliza < y > para escribir un tipo genérico. En este caso no es una convención que si se utiliza una etiqueta cref entonces se puede utilizar en lugar de la GenericType{T} más feo GenericType&lt;T&gt;. Consulte here para obtener más información.

También desde esa página hay otra sugerencia si tiene que escribir un montón de < y > símbolos que se pone el texto en una sección CDATA:

/// <summary> 
/// This a simple collection which implements <see cref="IEnumerable{T}" /> 
/// </summary> 
/// <example> 
/// <![CDATA[ 
/// SimpleList<int> intList = new SimpleList<int>(); 
/// ]]> 
/// </example> 
0

Creo que esto puede ayudar.

Haga clic derecho en la función, seleccione "Documento de esta" para Ex.

public void Function_Name() 

convierte

/// <summary> 
/// Give the details here 
/// </summary> 
/// <param name=""></param> 
/// <returns> you can tel what it returns </returns> 
public void Function_Name() 

(que es todo auto generada).

Cuestiones relacionadas