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

Question

Haben Sie bemerkt, dass für einige Methoden in den Systembaugruppen, auch die .NET Reflector die entsprechende Dokumentation zeigt? Was bedeutet, dass die Dokumentation in der Montage Metadaten beibehalten werden.

Wie kann ich es mache für meine eigenen Baugruppen arbeiten? Das heißt, ich möchte, dass meine Kommentare zu meiner Methode, um zu sehen, wenn ich es in .NET Reflector widerspiegeln.

Danke.

Answer 1

XML-Dokument Kommentare werden nicht in den Assembly-Metadaten beibehalten. In der Tat, Visual Studio und anderen Tool wie Reflektor XML-Dokument Kommentare suchen, indem Sie durch eine Reihe von bekannten Wegen zu suchen, die XML-Doc-Kommentar-Dateien enthalten.

Wenn Sie XML wollen Dokumentation für die eigene Baugruppen anzuzeigen, stellen Sie sicher, dass die XML-Datei im selben Verzeichnis wie die Anordnung Bezug genommen wird, und teilt den gleichen Namen wie die Assembly (abzüglich der Erweiterung). Zum Beispiel entspricht MyAssembly.Namespace.XML zum MyAssembly.Namespace.dll Montag.

Siehe Wie XML-Kommentare des Codes sehen von Reflector für weitere Informationen.