2012-09-23 21 views
22

Cuando quiero tener un atributo y documentación XML para un método/propiedad, ¿cuál es el orden correcto para escribirlos sobre el método/propiedad?Atributos y documentación XML para método/propiedad

Esto suena tan trivial, pero ...

si uso:

/// <summary> 
/// Something here 
/// </summary> 
[MyAttribute] 
public void MyMethod() {} 

Construir tiene éxito y ReSharper es "feliz", pero no veo la documentación de IntelliSense para MyClass.MyMethod .

Cuando uso:

[MyAttribute] 
/// <summary> 
/// Something here 
/// </summary> 
public void MyMethod() {} 

construcción es exitoso, pero ReSharper tiene una advertencia (comentario XML no se coloca sobre un elemento de lenguaje válido), y sigo sin ver la documentación en IntelliSense para MyClass.MyMethod.

He buscado en Internet y veo solo ejemplos donde los atributos se usan sin documentación; o documentación sin atributos.

¿Realmente no hay forma de tener atributos y documentación XML para el mismo método/propiedad?

Información: aplicación WPF, .NET 4.0, C#.

+0

Visual Studio (o tal vez resharper)? Simplemente escriba tres barras /// sobre el método (o atributo) y se generará automáticamente. – spender

+0

Olvidé agregar - VS2010. Intenté escribir encima del atributo (primer caso más arriba) pero no generé documentación en IntelliSense. Otros métodos/propiedades en la misma clase sin atributos muestran la documentación como se esperaba. :( – XAMeLi

+0

Cuando ambos casos no aparecen en Intellisense, entonces tiene un problema no relacionado que resolver primero. –

Respuesta

20

Usar el primer caso,

/// <summary> 
/// Something here 
/// </summary> 
[MyAttribute] 
public void MyMethod() {} 

ReSharper le gusta y hay que darle algo aquí en Intellisense. Cuando no, entonces hay otro problema por resolver.

+0

Necesario para reiniciar mi máquina ... La mayoría perdí dos horas en mi vida ... Gracias por la ayuda. – XAMeLi

+1

Gracias por salvarme algunas horas más de codificación y búsqueda +1 – Simua

Cuestiones relacionadas