Erben-Dokumentation in C#?

Aus Java und Eclipse bin ich auf @inheritDoc erlaubt, verwenden Sie die gleichen Unterlagen wie in der base-Klasse/- Methode.

Wie kann ich erreichen, etwas ähnliches auch in C# und Visual Studio 2010?

InformationsquelleAutor RoflcoptrException | 2011-03-14
  1. 12

    Dann existiert es nicht in vanilla VS. Ihre beste Wette ist, ghostdoc oder ähnliches. Diese ist in den Extension Manager, oder hier

    • Vielleicht ein update zu dieser --> das neue Dokumentations-tool von Microsoft 'Docfx' kann damit umgehen
    InformationsquelleAutor Marc Gravell
  2. 15

    Sogar diese Frage ist ein paar Jahre alt und es wurde speziell für Visual Studio 2010. Für alle diejenigen, die hier land von Google, ich möchte hinzufügen, eine Antwort, die ich fand, und das gilt für Visual Studio 2015 in Kombination mit Sandcastle Help File Builder (SHFB):

    ///<inheritdoc/>

    kann verwendet werden, um Erben, die docs, die von einer Basisklasse oder ein interface.

    Hier ein link zu den Sandcastle Help File Builder (SHFB) - Dokumentation:
    Mit dem <inheritdoc /> - Tag

    • Gibt es einen shortcut im Visual Studio für das einlegen /// <inheritdoc /> ?
    • Sie können erstellen Sie ein snippet selbst und weisen, dass eine Verknüpfung
    InformationsquelleAutor Horoman
  3. 4

    ReSharper bietet nicht nur Tastenkombinationen zum kopieren Basisklasse Kommentare, aber es tatsächlich enthält <inheritdoc> Kommentare in Ihre benutzerdefinierte intellisense, wie Sie wollen. Dies funktioniert nur, wenn Ihre ganze team ist mit ReSharper natürlich.
    Die Verwendung von <inheritdoc> ist gut erklärt hier

    InformationsquelleAutor Bob
  4. 1

    Resharper bietet Verknüpfungen zu kopieren Sie die XML-Dokumentation von Basis-Klassen.

    InformationsquelleAutor Humberto
  5. 1

    Mein add-in, AtomineerUtils wird die doppelte Dokumentation von überschreibungen der Basisklasse und interface-Methoden/- Eigenschaften, von überlastungen in der gleichen Klasse, und für Parameter es wird sich auch für die gleichnamigen Parameter verwendet, die an anderer Stelle in der gleichen Klasse.

    Können Sie auch in der Lage sein zu verwenden Erweiterung der XML Befehle wie <inheritdoc> oder <include> wenn Sie wollen, um den text zu duplizieren in der externen Dokumentation (Sandcastle, Doxygen, etc), aber ich bin mir nicht bewusst, in irgendeiner Weise "dynamisch" Erben-Dokumentation für "internen" Gebrauch (intellisense etc)

    InformationsquelleAutor Jason Williams
  6. 1

    Landete ich ein Werkzeug zu erstellen, zum hinzufügen der Unterstützung für das ersetzen der <inheritdoc/> - tag durch die post-Verarbeitung der XML-Dokumentationsdateien. Verfügbar unter http://www.inheritdoc.io (Kostenlose version verfügbar).

    InformationsquelleAutor K Johnson
  7. 1

    NDoc3.

    NDoc3 basiert auf NDoc, und ist ein code-Dokumentation-generation-tool für .NET Entwickler. Das Ziel ist schnell, erweiterbar, multi-Plattform .NET-Dokumentations-tool, das unterstützt wird .NET-Sprachen Spezifikationen, einschließlich, aber nicht nur, C#

    InformationsquelleAutor Kumar
Schreibe einen Kommentar