Verwendung von Attributen für die Dokumentation in C # [geschlossen]

Question

Verwendung von Attributen für die Dokumentation in C # [geschlossen]

8

In der MSDN Tutorial Attribute sie verwenden Author als Beispiel für ein Attribut:

%Vor%

Das schien ihm eine gute Idee zu sein, weil es Ihnen Reflexion Gruppenunterricht nach Autor (zum Beispiel) zu verwenden, würde es ermöglichen - effektiv Aussetzen Metadaten, die normalerweise in der Dokumentation zu dem Compiler wären, was nützlich sein könnte. Ich dachte sofort „Aha, ich sollte Attribute für alle meine Inline-Block-Dokumentation verwenden!“ - z.

%Vor%

Doch keine von the Antworten konnte ich über Dokumentation und Attribute finden, die diese Methode vermuten lassen. Sie alle verwenden XML für die Inline-Dokumentation.

Gibt es integrierte Attribute zur Unterstützung der Inline-Dokumentation? Wenn nicht, gibt es keine Bibliotheken / Pakete gibt, die sind vordefinierte Sätze von Attributen für die Inline-Dokumentation

.net c# attributes documentation

Robin Winslow 01.10.2012, 09:45

quelle

3 Antworten

3

Die Frage scheint hier zu sein: "Was ist Dokumentation?". Wenn das "Zeug", an dem Sie interessiert sind, durch Reflexion zugänglich sein muss, dann ist Ihre implizite Lösung von Attributen eine Lösung. Aber wenn die Absicht darin besteht, Standarddokumentationstools zu verwenden, um Dokumentation zu erstellen, dann nicht.

Die Notwendigkeit hier bittet um die Lösung. Was ist die Notwendigkeit für die "Dokumentation"? Vielleicht die falsche Frage?

Rob Smyth 01.10.2012 10:10

quelle

0

Nur um es der Vollständigkeit halber zu erwähnen, konnten Sie in den Testprojekten Folgendes tun:

%Vor%

Sie können diesen Ansatz für regulären Code erweitern. Ich möchte eher nicht zu theoretischen Fragen Stellung nehmen. Das heißt, vielleicht kann ein Skript, das Repository verwendet, um alle "Autoren" / "Editoren" der spezifischen Datei / Klasse / Methode zu extrahieren, erstellt werden.

majkinetor 12.10.2012 12:27

quelle

Tags und Links .net c# attributes documentation

Django: Verwenden von Annotate, Count und Distinct in einem Queryset MS Access 2010: "Es können keine weiteren Datenbanken geöffnet werden."

score 5 · Accepted Answer

Einige Nachteile der Dokumentation in Attributen:

schlechte Formatierung für lange Texte;
keine Unterstützung durch Visual Studio-Add-Ons (z. B. mithilfe der ReSharper-Dokumentationsvorschaufunktion);
keine Unterstützung durch Drittanbieter-Dokumentationserstellungswerkzeuge;
Aufnahme von Dokumentationen in Baugruppen, was das Reverse Engineering erheblich erleichtert;
Duplizieren von Metadaten in Quellcodes mit Metadaten, die in einem Versionskontrollsystem gespeichert sind (es hat keinen Sinn, den Autor und die Version einer Deklaration im Quellcode zu verfolgen, wenn das VCS viel genauere Informationen liefert - VCS nicht lüge ).

Ich kann mir momentan keinen Vorteil vorstellen. Für den Fall, dass ich wirklich brauche, ist es immer möglich, die XML-Dokumentationskommentare zu analysieren und die gesamte Codebasis in ein attributiertes Formular umzuwandeln.