2012-09-23 4 views
22

Wenn ich ein Attribut und XML-Dokumentation für eine Methode/Eigenschaft haben will - was ist die richtige Reihenfolge sie über der Methode/Eigenschaft zu schreiben?Attribute und XML-Dokumentation für die Methode/Eigenschaft

Das klingt so trivial, aber ...

Wenn ich benutze:

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

Build ist erfolgreich und ReSharper ist "glücklich", aber ich sehe nicht die Dokumentation in IntelliSense für MyClass.MyMethod .

Wenn ich:

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

Build ist erfolgreich, aber ReSharper hat eine Warnung (XML-Kommentar mit einem gültigen Sprachelement nicht platziert ist), und ich sehe immer noch nicht in die Dokumentation in IntelliSense für MyClass.MyMethod.

Ich habe das Internet gesucht und nur Beispiele sehen, wo Attribute ohne Dokumentation verwendet werden; oder Dokumentation ohne Attribute.

Gibt es wirklich keine Möglichkeit, Attribute und XML-Dokumentation für die gleiche Methode/Eigenschaft haben?

Info: WPF-Anwendung, .NET 4.0, C#.

+0

Visual Studio (oder vielleicht Nachschneider)? Geben Sie drei Schrägstriche /// oberhalb der Methode (oder des Attributs) ein und es wird automatisch generiert. – spender

+0

Vergessen zu hinzufügen - VS2010. Ich habe versucht, über das Attribut zu schreiben (erster Fall oben), aber es hat in IntelliSense keine Dokumentation generiert. Andere Methoden/Eigenschaften in derselben Klasse ohne Attribute zeigen die Dokumentation wie erwartet an. :( – XAMeLi

+0

Wenn beide Fall nicht in Intellisense angezeigt werden, dann haben Sie ein Problem ohne Beziehung zuerst zu lösen. –

Antwort

20

Verwenden Sie den ersten Fall

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

ReSharper mag es und es sollten Sie Etwas hier in Intellisense geben. Wenn dies nicht der Fall ist, muss ein anderes Problem gelöst werden.

+0

Benötigt, um meine Maschine neu zu starten ... Am meisten verschwendet zwei Stunden in meinem Leben ... Danke für die Hilfe – XAMeLi

+1

Vielen Dank für Ihre Rettung Noch ein paar Stunden zum Codieren und Suchen +1 – Simua

Verwandte Themen