2012-09-23 19 views
22

Kiedy chcę mieć atrybut i dokumentację XML dla metody/właściwości - jaka jest właściwa kolejność zapisu ich powyżej metody/właściwości?Atrybuty i dokumentacja XML dla metody/właściwości

Brzmi to tak trywialne, ale ...

Jeśli używam:

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

Budowa zakończy się powodzeniem i ReSharper jest "szczęśliwy", ale nie widzę w dokumentacji IntelliSense dla MyClass.MyMethod .

Gdy używam:

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

Budowa zakończy się powodzeniem, ale ReSharper ma ostrzeżenie (XML komentarz nie został umieszczony na ważnego elementu języka), a ja nadal nie widzę dokumentację w IntelliSense dla MyClass.MyMethod.

Przeszukałem Internet i widziałem tylko przykłady, w których atrybuty są używane bez dokumentacji; lub dokumentacja bez atrybutów.

Czy naprawdę nie ma sposobu na posiadanie atrybutów i dokumentacji XML dla tej samej metody/właściwości?

Info: Aplikacja WPF, .NET 4.0, C#.

+0

Visual Studio (a może resharper)? Po prostu wpisz trzy ukośniki /// powyżej metody (lub atrybutu) i zostanie automatycznie wygenerowany. – spender

+0

Zapomniałem dodać - VS2010. Próbowałem napisać powyżej atrybutu (pierwszy przypadek powyżej), ale nie generował on dokumentacji w IntelliSense. Inne metody/właściwości w tej samej klasie bez atrybutów pokazują dokumentację zgodnie z oczekiwaniami. :( – XAMeLi

+0

Gdy oba przypadki nie pojawią się w Intellisense, masz do rozwiązania niezwiązany problem –

Odpowiedz

20

użytkowania pierwszy przypadek,

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

Resharper lubi i powinno dać tutaj coś w IntelliSense. Jeśli tak się nie stanie, jest jeszcze jeden problem do rozwiązania.

+0

Potrzebny do ponownego uruchomienia komputera ... Większość straconych dwie godziny w moim życiu ... Dzięki za pomoc – XAMeLi

+1

Dzięki za uratowanie mnie kolejne godziny kodowania i wyszukiwania +1 – Simua