Framework Goto Definition zeigt Kommentare. Werden diese aus XML -Kommentaren generiert?

Question

Ich war kürzlich leicht überrascht zu entdecken, dass meine sorgfältig gefertigten XML -Kommentare für meine Kollegen nicht in Intellisense auftauchten. Nachdem ich die zugehörigen Baugruppen immer mit Projektreferenzen verwendet hatte, hatte ich nicht erkannt, dass Sie das .xml -Dokument auch exportieren mussten, um auf diese Informationen zuzugreifen.

Dies führte mich dazu, wie das .NET -Framework IntelliSense funktioniert. Wenn ich richtig verstehe, müssen die .xml -Dateien irgendwo in einem speziellen Ordner versteckt werden?

Aber meine Hauptfrage liegt bei der 'Goto -Definition' - wenn Sie auf einer .NET -Framework -Assembly auf Definition gehen, erhalten Sie die Informationen aus Metadaten - aber auch mit vielen hilfreichen Kommentaren - diese werden auf magische Weise aus XML -Kommentaren generiert oder hatte jemand jemand Ein Makro + schreiben, um sie nur für den Build zu konvertieren? Anders ausdrücken: Wie kann ich diesen Effekt für meine Baugruppen bekommen?

Answer 1

Sind Ihre Projekte für die Generierung der XML -Dokumentation konfiguriert? Nur weil Sie die Kommentare zum Quellcode hinzufügen, generiert der Compiler die .xml -Datei nicht, es sei denn, sie wird darauf hingewiesen.

Gehen Sie auf der Seite "Projekteigenschaften" zur Registerkarte "Build" und schauen Sie sich den Abschnitt "Ausgabe" an. Sie sollten einen Checkbox -Eintrag mit dem Titel "XML -Dokumentationsdatei" sehen. Wenn das Textfeld dieses Kontrollkästchen leer ist, generieren Sie nicht die XML -Dokumentationsdatei.

Sobald Sie die XML -Dokumentationsdatei generiert haben, sollten Sie Ihre Kommentare in den IntelliSense -Tooltips sehen. Wenn Sie Verweise auf andere Projekte als Projektreferenz einfügen, sollte dies automatisch geschehen. Wenn Sie Verweise auf Baugruppen eingeben, müssen Sie sicherstellen, dass sich die XML -Datei an derselben Stelle wie die referenzierte Montage befindet. (Wenn Sie erstellen, sollten Sie XML -Dateien für alle Baugruppen erhalten, die sie im Ordner Bin/Debug oder Bin/Release haben.)

Für die .NET -Framework -Assemblys selbst werden die entsprechenden XML -Dokumentationsdateien als Teil des Frameworks installiert. Für .NET 2.0, 3.0 oder 3.5 Die Dokumentationsdateien befinden sich unter C:\Windows\Microsoft.NET\Framework\v2.0.50727\en (Annahme einer Standardinstallation des Frameworks). Diese Dateien werden sowohl von den IntelliSense -Tooltips als auch von der Funktion "zur Definition gehen" in Visual Studio verwendet, um diese Informationen anzuzeigen. Es gibt keine spezielle Verarbeitung, die stattfindet oder Makros ausgeführt werden, um dies zu erreichen. Das einzige Informationen, das Visual Studio höchstwahrscheinlich verwendet, ist eine Kombination aus Registrierungsschlüssel, um den richtigen Pfad zu den Dokumentationsdateien zu bestimmen.

Während Sie wahrscheinlich die XML-Dokumentationsdateien für Ihre eigenen Baugruppen im selben Ordner finden können, würde ich dagegen empfehlen, wenn Sie die Framework-Installation mit nicht-ramework-verwandten Dateien verschmutzen.