Wie können die .NET-Quellcode-XML-Kommentare in den Assemblymetadaten beibehalten werden?

Question

Ist Ihnen aufgefallen, dass bei einigen Methoden in den System-Assemblies der .NET Reflektor auch die entsprechende Dokumentation anzeigt? Dies bedeutet, dass die Dokumentation in den Assemblymetadaten beibehalten werden kann.

Wie kann ich es für meine eigenen Baugruppen arbeiten lassen? Das heißt, ich möchte meine Kommentare zu meiner Methode sehen, wenn ich sie im .NET Reflektor reflektiere.

Danke.

Answer 1

XML-Dok-Kommentare werden nicht in den Assemblymetadaten beibehalten. Tatsächlich finden Visual Studio und andere Tools wie Reflector XML-Dokumentenkommentare, indem sie eine Reihe bekannter Pfade durchsuchen, die XML-Dokumentationskommentendateien enthalten.

Wenn Sie die XML-Dokumentation für Ihre eigenen Assemblys anzeigen möchten, stellen Sie sicher, dass sich die XML-Datei im selben Verzeichnis wie die referenzierte Assembly befindet und denselben Namen wie Ihre Assembly (ohne die Erweiterung) hat. Zum Beispiel entspricht MyAssembly.Namespace.XML der MyAssembly.Namespace.dll Baugruppe.

Weitere Informationen finden Sie unter How to see XML comments of the code from Reflector.