Wie dokumentiere ich eine c # dll?

8

Wie schreibe ich eine Klasse, so dass Eigenschaften und Methodenbeschreibungen für Personen sichtbar sind, die auf die DLL in anderen Projekten verweisen?

%Vor%

funktioniert nicht, auch nicht

%Vor%     
James 03.02.2010, 15:27
quelle

4 Antworten

14

In Visual Studio:

  

Projekt - & gt; Eigenschaften - & gt; Bauen - & gt; Überprüfen Sie "XML-Dokumentationsdatei".

Weitere Informationen finden Sie unter XML-Kommentare, mit denen Sie direkt aus Ihren Visual Studio .NET-Quelldateien eine Dokumentation erstellen können .

    
jason 03.02.2010, 15:30
quelle
1

Die Beschreibung in DescriptionAttribute ist im Property Grid sicher sichtbar und hat nichts mit dem Code-Editor zu tun.

Damit XML-Kommentare verfügbar sind, müssen Sie eine XML-Dokumentationsdatei und versende es mit deiner Versammlung.

    
Anton Gogolev 03.02.2010 15:29
quelle
1

Haben Sie die XML documentation file für Ihren zweiten Fall erstellt?

  

Projekteigenschaften - & gt; Bauen - & gt; [Ausgabe] XML-Dokumentationsdatei

    
tanascius 03.02.2010 15:30
quelle
1

Der zweite sollte funktionieren (Zusammenfassung), achten Sie darauf, dass Sie in der XML-Dokumentationsdatei des Projekts (Build - & gt; Output) auswählen.

    
Alex LE 03.02.2010 15:32
quelle

Tags und Links

Django: Verwenden von Annotate, Count und Distinct in einem Queryset (Wicket) Ändere die Sichtbarkeit während der Ajax-Antwort