12 Stimmen

Kann ich in einem Xml-Dokument einen Verweis auf eine Methodengruppe einfügen? Wie?

In C# kann ich die Dokumentation für Eigenschaften, Methoden, Ereignisse usw. anhängen, direkt im Code mit Kommentare zur XML-Dokumentation .

Ich weiß, wie man einen Verweis auf eine bestimmte Methode einfügt:

<see cref="MethodName(TypeForArg1, TypeForArg2..)"/>

Gibt es eine Möglichkeit, einen Verweis auf eine Methodengruppe ? Wo ich mehrere Überladungen des gleichen Methodennamens habe...

Ich habe versucht

<see cref="M:MethodName"/>

aber das hat nicht funktioniert.

EDITAR: BUMP

3voto

Cheeso Punkte 184210

Offenbar gibt es keine Möglichkeit, dies zu tun.

2voto

p.s.w.g Punkte 140905

Es scheint, dass dies zumindest in Visual Studio 2012 behoben wurde:

<see cref="MethodName"/>

Es wird eine Warnung ausgegeben:

Zweideutiger Verweis im Attribut cref: 'Methodenname'. Angenommen ' ', könnte aber auch auf andere Überladungen einschließlich ' ' passen.

Aber das Hinzufügen einer M: vorne wird die Warnung entfernt:

<see cref="M:MethodName"/>

0voto

Jax Punkte 6607

Dies wird jetzt in Sandcastle unterstützt.

Um eine Methodengruppe zu referenzieren, ist 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 aufweist, wie beschrieben diese C#-Sprachfunktion anfordern .

  • Die Syntax wird während der Erstellung nicht validiert. Fehler, die während der Eingabe gemacht werden, werden erst gemeldet, wenn der Sandcastle Help File Builder die Kommentare verarbeitet.
  • Die Syntax nur funktioniert, wenn es mehr als eine Methode mit demselben Namen gibt.
  • Es gibt keine Syntaxhervorhebung oder Editorunterstützung für diese Syntax.

CodeJaeger.com

CodeJaeger ist eine Gemeinschaft für Programmierer, die täglich Hilfe erhalten..
Wir haben viele Inhalte, und Sie können auch Ihre eigenen Fragen stellen oder die Fragen anderer Leute lösen.

Powered by:

X