In xml doc, kann ich einen Verweis auf eine Methodengruppe einfügen? Wie?
-
05-07-2019 - |
Frage
In C # kann ich Dokumentation anhängen für Eigenschaften, Methoden, Ereignisse und so weiter, direkt im Code XML Kommentare zur Dokumentation verwenden.
Ich weiß, wie ein Verweis auf ein bestimmtes Verfahren einzufügen:
<see cref="MethodName(TypeForArg1, TypeForArg2..)"/>
Gibt es eine Möglichkeit, einen Verweis auf eine Methodengruppe einfügen ? Wo habe ich mehrere Überlastungen der gleichen Methode Namen bekommen hat ...
Ich habe versucht,
<see cref="M:MethodName"/>
.. aber das hat nicht funktioniert.
EDIT: STOSS
Lösung
Anscheinend gibt es keine Möglichkeit, dies zu tun.
Andere Tipps
Es scheint, dass dies zumindest in Visual Studio 2012 festgesetzt wurde:
<see cref="MethodName"/>
Wird eine Warnung erzeugen:
Mehrdeutige Referenz in cref-Attribute: 'Method'. Unter der Annahme, '...', sondern könnten auch andere Überlastungen einschließlich Matched '...'.
Aber das Hinzufügen eines M:
vor gets der Warnung los:
<see cref="M:MethodName"/>
Dies wird jetzt in Sandcastle unterstützt.
ein Verfahren Gruppe verweisen, die folgende Syntax erforderlich:
/// <summary>
/// Reference to a method group with two items:
/// <see cref="O:Full.Declaring.Namespace.TypeName.Foo"/>
/// </summary>
void Foo() { }
void Foo(int x) { }
Beachten Sie, dass diese Syntax noch einige Einschränkungen hat, wie diese C-Funktion Anfrage # Sprache .
- Die Syntax wird nicht während der Build validiert. Fehler während der Eingabe werden, bis nicht gemeldet, wenn / falls Sandcastle Help File Builder die Kommentare verarbeitet.
- Die Syntax nur funktioniert, wenn es mehr als eine Methode mit dem gleichen Namen.
- Es gibt keine Syntax-Hervorhebung oder Editor Unterstützung für diese Syntax.