Wie man ein cref-Methode zu überlastungen in ein <seealso> - tag in C#?

Sehe ich in der MSDN-links wie "CompareOrdinal-Overloads". Wie kann ich schreiben, wie eine Verknüpfung, in C#?

Habe ich versucht:

<seealso cref="MyMethod">MyMethod Overloads</seealso>

Aber der compiler gibt mir eine Warnung über einen mehrdeutigen Verweis für die Methode, die anderen überladungen.

(Anfänger-Frage: brauche ich eigentlich zum schreiben dieses Tags zu verknüpfen, um die überlastung, oder ist es automatisch generiert Dokumentation Prozessoren?)

InformationsquelleAutor Hosam Aly | 2009-01-07
  1. 5

    Xml-Dokumentation, die nicht ein Mittel zur Referenz alle überladungen einer Methode.

    Den beliebtesten Dokumentations-generator für C# - Projekte Sandburg. Es wird automatisch ein link zu einer überlastung Liste Seite, wenn nötig. Daher werden in einer Mitglieder-Liste den Namen einer überladenen Methode wird nur einmal angezeigt, ein Klick navigieren Sie zu der Liste von überlastungen Seite für diese Methode und von dort aus zu einer bestimmten überlast.

    Platzieren Sie einen link zum überlast-Listen-Seite in der Xml-Dokumentation erfordern würde intime Kenntnis des externen Tools, die verwendet werden und wahrscheinlich nicht eine gute Idee.

    Wenn Sie wirklich müssen haben, dann ist vielleicht eine Möglichkeit ist die Verwendung eines Ankers mit einem speziell gebildet-ID. Die meisten Dokument-Generatoren bieten einige Arkane mittels pre-oder post-processing-Dateien erzeugt und sollte Ihnen die Gelegenheit geben, zu wählen diese Anker aus und geben Sie einen entsprechenden "href" für Sie.

    OTH, kann es mehr Mühe als sein Wert 😉

    • Sandcastle ' s Verhalten sollte genug sein für mich. Danke für die info.
    InformationsquelleAutor AnthonyWJones
  2. 14

    Ziel bestimmten Mitglieder, ich glaube, dass Sie nur mit der Signatur:

    ///<seealso cref="Foo(int)"/>
static void Foo() { }
///<seealso cref="Foo()"/>
///<seealso cref="Foo(float)"/> <------ complains
static void Foo(int a) { }

    Um ehrlich zu sein, ich bin mir nicht sicher, wie Sie Sie erzeugen eine "alle überladungen" - link, würde ich davon ausgehen, dass jeder vernünftige generator Tat dies automatisch.

    • Danke. Funktioniert der generator, die Sie verwenden, tun Sie dies automatisch?
    • Ich weiß nicht wirklich einen generator; die xml allein ist gut für meine Nutzung (es ist sowohl durch die intellisense und Reflektor). Ich don ' T müssen in der Regel eigenständige Dokumentation.
    InformationsquelleAutor Marc Gravell
  3. 13

    Verwendung von Sandcastle ist es ganz einfach:

    <seealso cref="overloads:FullyQualifiedMyMethod">MyMethod Overloads</seealso>

    FullyQualifiedMyMethod ist die komplette route, die Sie brauchen, um zu erreichen der überlast, einschließlich namespaces und Klassen, D. h: System.Linq -.Enumerable.Summe

    Allerdings VB-compiler gibt eine Warnung aus, daß das Attribut kann nicht aufgelöst werden, die ignoriert werden können.

    • Tests mit SHFB 2014.5.31.0 zeigt an, dass der Präfix muss o:, nicht overloads:.
    • Und der C# - compiler (getestet für lang-version 5.0) nicht die Ausgabe einer Warnung, wenn mit o:, also vielleicht ist der Weg zu gehen.
    • Habe versucht, mit einem sehen (anstatt seealso) und hatte kein Glück überhaupt. überlast: die Fragen, die eine compiler-Warnung UND SHFB 14.5.31 ignoriert es. Habe auch versucht o: und M: und der compiler ist okay, aber SHFB ignoriert Sie die beiden.
    • Ich möchte sagen, dies sollte die akzeptierte Antwort, aber dann wieder OP nicht geben Sandcastle also, hmm... vielleicht auch nicht. Immer noch sehr nützlich +1.
    InformationsquelleAutor Wilhelm
Schreibe einen Kommentar