Frage

Ich habe eine Versammlung sehr gründlich XML-basierte Dokumentation enthält, die durch Sandcastle verwendet wird, um die Hilfe-Dateien für das Produkt zu erzeugen. Wir verwenden auch die Ausgabe von XML-Dateien für die richtige Intellisense in Visual Studio bereitstellt, wenn Programmierer offensichtlich die Montage verwendet werden.

Um dies zu tun, es scheint, wir haben beides die Benutzer mit der Anordnung ( „assembly.dll“) liefern und der Dokumentation ( „assembly.xml“).

Ist es irgendwie möglich, die Dokumentation innerhalb der Baugruppe einzubetten, so würden wir nur die einzelne Assembly-Datei und Visual Studio wäre in der Lage liefern müssen, um die Informationen zu extrahieren? Vielleicht als Ressource oder so ähnlich eingebettet?

War es hilfreich?

Lösung

Leider müssen Sie sowohl als Visual Studio liefern nur in XML-Dokumenten für Intellisense zu suchen weiß.

Andere Tipps

Wenn Sie suchen C: \ Windows \ Microsoft.NET \ Framework \ v2.0.50727 werden Sie feststellen, dass alle der .NET-Assemblies Sie in Ihren Anwendungen werden Referenzierung kann die XML-Dateien verwenden. Visual Studio wird nur Intellisense für Baugruppen liefern, wenn die XML-Datei vorhanden ist. Zum Beispiel, wenn Sie Visual Studio schließen waren, dann die System.Drawing.xml Datei entfernen und dann VS wieder öffnen, sollte es keine Intellisense für die Montage sein. Sie würden dann VS schließen müssen, kopieren Sie sie zurück, und dann VS für die Intellisense wieder öffnen wieder zu arbeiten.

Bin ich etwas fehlt? Ich Kommentar immer wie gewohnt (mit 3 Schrägstrichen oder 3 Striche (vb)), die in XML-Tags verwenden errichtet und wenn ich die Assembly verwenden bekomme ich die Intellisense - ich selten eine extrernal XML-Datei verwenden.

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top