2010-02-12 13 views
6

einen Delegierten wieWie geben Sie XML-Kommentare/-Dokumentation für die Delegatparameter an?

Func<string,string,string> MyFunc = (firstName,lastName) => string.Format("Given Name:{0} Surname:{1}", 
                      firstName, 
                      lastName); 

gegeben Wie würden Sie können Sie die Parameter von Vorname und Nachname zu dokumentieren, so zeigen sie in intellisense up (wie Methodenbeschreibungen und Parameter zu tun)?
Beispiel:

/// <summary> 
/// My Method 
/// </summary> 
/// <param name="firstName">The first name.</param> 
/// <param name="lastName">The last name.</param> 
/// <returns></returns> 
public string MyMethod(string firstName, string lastName) 
{ 
    return string.Format("Given Name:{0} Surname:{1}",firstName,lastName); 
} 

ich über den Delegierten schweben wollen oder Intellisense Popup haben, wenn ich und sagen Sie mir die Beschreibungen für die die Delegierten Parameter eingeben, wie es mit dem obigen Verfahren würde.

+0

Für mich scheint es seltsam, eine anonyme Funktion zu dokumentieren. – Foole

Antwort

8

Ein Feld eines Delegattyps ist immer noch ein Feld und keine Methode — es nimmt Parameter in sich nicht. Die Parameter gehören zum Stellvertreter Typ, nicht der Delegierten Feld. Sie können die Kommentare für Parameter schreiben, wenn Sie Typen delegieren, wenn Sie möchten.

Func<string,string,string> ist ein allgemeiner Vertreter für Funktionen mit drei Parametern. Für bestimmte Zwecke können Sie immer einen eigenen Delegattyp deklarieren, der die abstrahierte Methode genauer darstellt, und Kommentare zu den Parametern hinzufügen.

+0

Es ist schade, dass es keine Möglichkeit gibt, eine Dokumentation zu liefern, die intellisense für eine 'Func übernimmt. In vielen Fällen wird erwartet, dass die einer solchen deklarierten Variablen zuzuordnende Funktion bestimmte Aufgaben erfüllt und es gibt bestimmte Erwartungen darüber, was passiert ist und was zurückgegeben wird. –

Verwandte Themen