2010-02-03 7 views
8

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

[Description("My age in years attribute")] 
    public int Age 
    { 
     get { return 0; } 
     set { } 
    } 

funktioniert nicht, ebenso wenig wie

/// <summary> 
    /// My age in years attribute 
    /// </summary> 
    public int Age 
    { 
     get { return 0; } 
     set { } 
    } 
+0

Ihr zweiter * funktioniert * für mich. –

+0

Vielleicht vermisse ich etwas, aber die XML-Kommentare funktionieren für mich. –

+0

Das zweite Beispiel funktioniert, wenn das Projekt, das auf die Klasse verweist, in derselben Lösung ist. Ich kompiliere die Klasse als DLL und referenziere diese DLL. Die DLL scheint keine Attribut- oder Zusammenfassungsinformationen zu speichern. – James

Antwort

14

In Visual Studio:

Projekt -> Eigenschaften -> Erstellen -> Überprüfen Sie "XML-Dokumentationsdatei".

Weitere Einzelheiten finden Sie unter XML Comments Let You Build Documentation Directly From Your Visual Studio .NET Source Files.

+0

Bedeutet das, dass ich das XML mit der DLL verteilen und sie beide verweisen muss? Gibt es eine Möglichkeit, wie ich alle Informationen in der DLL haben kann? – James

+0

Nein, die XML-Kommentare sind kein Bestandteil von Metadaten in der Assembly. – jason

+0

Wie mache ich sie zu einem Teil der Metadaten? – James

1

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

Damit XML-Kommentare zur Verfügung stehen, müssen Sie generate an XML documentation file und versenden Sie es mit Ihrer Baugruppe.

1

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

Projekteigenschaften -> Build -> [Output] XML-Dokumentationsdatei

1

Die zweite sollte (Zusammenfassung) arbeiten, sollten Sie in den Projekteigenschaften auswählen (Build -> Output) XML-Dokumentationsdatei .

Verwandte Themen