Kommentare in VS 2008 beim Erstellen von dll-Dateien

Hallo Leute,

die meisten kennen Wahrscheinlich die automatische Dokumentation in VS 2008. Damit meine ich die praktischen Hilfestellungen wenn man eine Klasse oder einen Methodennamen eingibt und sofort ein Fenster mit dem Kommentartext erscheint.
Wenn ich jetzt eigene Klassen erstelle kann ich ja sowas vor eine Methode schreiben und erhalte auch die gleiche Hilfe wie bei den .NET Funktionen

<summary>
zum bearbeiten von xyz...
</summary>
<param name="device">Name des Gerätes</param>
<exception cref="DamnBadException"/>
<returns>Erfolg der Methode</returns>
public static bool doSomething(String device)  {

Jetzt zu meinem Problem:
Wenn ich eine dll Datei erstelle und diese dann in einem anderen Projekt importiere, werden mir deise Kommentare nicht mehr angezeigt. Muss ich beim Compiler etwas umstellen, da mit die kommantare uch in der dll landen?

Schonmal vielen Dank für eure Hilfe

Gruß
Nathon

Firefighter

Inwiefern sie werden nicht mit angezeigt?Bei der Intellisense oder wo?

Ja genau ich glaube das heißt intellisense.
Diese gelb hinterlegten Boxen die beim MouseOver oder STRG+Space auftauchen.

Weißt du warum die bei Klassen aus einer importieren dll nicht auftauchen?

Gruß
Nathon

Firefighter

Also ich hab das eben mal getestet.Und bei mir tauchen die auf und mir werden auch die Kommentare angezeigt.
Ich weiß nicht ob du es in deinem Code wirklich so gemacht hast wie du es uns gepostet hast, weil dann geht es 100% nicht. Eigentlich sollte das eher so aussehen

///<summary>
///Hier deine Kommentare usw.
///</summary>
public class Class1
{
}

Eventuell hast du das nur falsch gemacht. Aber ansonsten werden die immer angezeigt.

Hallo,

die Kommentare werden nicht in der DLL gespeichert, sondern in einer extra XML Datei (eventuell muss man die Erstellung der XML Datei in den Projektoptionen noch aktiviert werden). Die DLL muss dann dort liegen wo die DLL liegt, damit Intellisense die verarbeiten kann.

Kleiner vertippser: die XML Datei muss dann dort liegen wo die DLL liegt.

zwergli schrieb:

Hallo,

die Kommentare werden nicht in der DLL gespeichert, sondern in einer extra XML Datei (eventuell muss man die Erstellung der XML Datei in den Projektoptionen noch aktiviert werden). Die XML muss dann dort liegen wo die DLL liegt, damit Intellisense die verarbeiten kann.

Genau das ist es. Unter "Eigenschaften -> Projekteigenschaften -> Erstellen -> Ausgabe -> XML-Dokumentationsdatei" anklicken und dann wird beim nächsten erstellen eine XML-Datei im Ausgabeverzeichnis abgelegt.

Eine Sache ist allerdings noch komisch. Es wird nur der Kommentar vom Konstruktor und nicht der von der Klasse selbst oder von Methoden angezeigt. Das hat zumindest mein erster Test ergeben. Werde da nochmal nachgehen.

Vielen Dank soweit!

War mein Fehler die getestete Methode hatte tatsächlich keinen Kommentar im Quelltext.
Funktioniert also komplett.

Besten Dank