FrEEzE2046 - Do 27.05.10 20:44
Titel: Externe Summarys werden nicht erkannt

---

Ich wollte meine Summarys in externe Dateien auslagern. Dies soll ja per <include> möglich sein. Ich habe original das Beispiel von MSDN benutzt ... aber ohne Erfolg.

Er kompiliert zwar ohne Warnung (mit /doc), aber das IntelliSense zeigt mir meine Summarys nicht an. Woran kann das liegen? Ich benutze das VS 2010 Premium.


PS:
Wenn ich zu jedem Member eine Description habe, muss ich dann vor jedes Member die include Anweisung packen oder gibt es eine bestimmte Syntax mit der man das gnaze am Klassenbeginn verlinken kann?

gfoidl - Do 27.05.10 20:57

---

Hallo,

Zitat:

Er kompiliert zwar ohne Warnung (mit /doc), aber das IntelliSense zeigt mir meine Summarys nicht an.

Im selben Projekt zeigt er das bei mir auch nicht an. Wird auf die Assembly jedoch verwiesen gehts schon.

Zitat:

Wenn ich zu jedem Member eine Description habe, muss ich dann vor jedes Member die include Anweisung packen

AFAIK ja.


mfG Gü

FrEEzE2046 - Do 27.05.10 20:59

---

gfoidl hat folgendes geschrieben :

Im selben Projekt zeigt er das bei mir auch nicht an. Wird auf die Assembly jedoch verwiesen gehts schon.

Wenn ich - klassisch - das <summary/> im code file benutze, dann zeigt er mir das aber auch im selben Projekt an!
Ich hatte es eigentlich aber schon probiert die Assembly in einem anderen Projekt zu referenzieren ... selbes Phänomen.

gfoidl - Do 27.05.10 23:25

---

Hallo,

beim <summary> kapiert das VS, bei <include> nicht. Warum das so ist weiß ich nicht.

Zitat:

Ich hatte es eigentlich aber schon probiert die Assembly in einem anderen Projekt zu referenzieren

Wurde die XML-Dokumentationsdatei erstellt? Sonst (kanns nicht) gehen. Dazu unter den Projekteigenschaften | Erstellen die Checkbox XML-Dokumentationsdatei aktivieren.


mfG Gü

FrEEzE2046 - Fr 28.05.10 08:23

---

Die Dokumentationsdatei wird erstellt, klar.

Also, es geht mir prinzipiell darum mit Sandcastle eine Dokumentation zu erstellen. Dabei brauche ich eine interne LibraryDeveloper-API und eine für den späteren User.
Damit das CodeFile nicht zu unübersichtlich wird, möchte ich die summarys in externe Dateien auslagern. Dies ist schon mal ein Fortschritt. Jedoch würde ich gerne darauf verzichten die include Anweisung vor jedes Member zu packen.

Ist es vielleicht möglich ein include so zu formulieren, dass ich am Anfang der Datei auf ein documentation xml verweise, in dem alle Klassen und Member beschrieben sind?

Falls nicht, würde ich mir gerne ein Tool schreiben das so funktioniert. Dafür muss ich aber wissen, auf welcher Basis Sandcastle die Dokumentation erstellt. Wenn es nur das von VS generierte DocumentationFile wäre, dann würde ich mir das eben von meinem Tool erstellen lassen, aber offenbar braucht Sandcastle auch die Assembly oder das SolutionFile. Das verleitet mich zu der Annahme, dass da auch irgendwas in die Assembly rein kompiliert wird, was wiederum bedeuten würde, dass die includes vor jedem Member notwendig wären.
Hat da jemand Informationen in dieser Richtung?

Kha - Fr 28.05.10 11:44

---

FrEEzE2046 hat folgendes geschrieben :

Ist es vielleicht möglich ein include so zu formulieren, dass ich am Anfang der Datei auf ein documentation xml verweise, in dem alle Klassen und Member beschrieben sind?

Glaube nicht, denn sonst bräuchte <include> ja noch einige XPath-Parameter, um zu den einzelnen Klassen/Membern/Parametern zu kommen. Eine Transformation in das XmlDoc-Format ist wahrscheinlich wirklich das sinnvollste, vielleicht sogar mit XSLT *g* ?

FrEEzE2046 hat folgendes geschrieben :

Das verleitet mich zu der Annahme, dass da auch irgendwas in die Assembly rein kompiliert wird, was wiederum bedeuten würde, dass die includes vor jedem Member notwendig wären.

Dass da nichts reinkompiliert wird, kannst du dich mit dem Reflector selbst überzeugen. Sandcastle wird die Assembly lediglich für Typinformationen benötigen.

FrEEzE2046 - Fr 28.05.10 13:45

---

Kha hat folgendes geschrieben :

FrEEzE2046 hat folgendes geschrieben : Das verleitet mich zu der Annahme, dass da auch irgendwas in die Assembly rein kompiliert wird, was wiederum bedeuten würde, dass die includes vor jedem Member notwendig wären. Dass da nichts reinkompiliert wird, kannst du dich mit dem Reflector selbst überzeugen. Sandcastle wird die Assembly lediglich für Typinformationen benötigen.

Soll heißen, IntelliSense schaut ebenfalls im Verzeichnis des Assembly nach einer Documentation-XML?

gfoidl - Fr 28.05.10 14:17

---

Hallo,

ja so ist es. Assembly + XML-Dok => Intellisense zeigt dir was an, außer im eigenen Projekt/Solution


mfG Gü