Entwickler-Ecke

Programmierwerkzeuge - Aus XML Kommentaren Dokumentation erstellen?


winx - Mi 17.01.07 22:03
Titel: Aus XML Kommentaren Dokumentation erstellen?
Hi,

wie kann ich in C# mit Vs2005 aus meinen XML Kommentaren eine (bspw HTML-) Dokumentation erstellen?

Danke,
winx


Christian S. - Mi 17.01.07 22:55

Ich glaube, das ging mit nDoc 2005 [http://sourceforge.net/projects/ndoc05/] ganz gut. Eventuell musst Du das selber kompilieren, das ging bei mir aber IIRC ganz problemlos :-)


winx - Mi 17.01.07 23:29

wo kann ich den in VS2005 die Erstellung der XML Kommentare einschalten???


winx - Mi 17.01.07 23:31

schon gefunden :-)


winx - Mi 17.01.07 23:34

Bekomm dauernd diesen Fehler (in ndoc):
Zitat:
Error compiling the namespace stylesheet



Exception: NDoc.Core.DocumenterException

Error compiling the namespace stylesheet



Exception: System.Exception

Error compiling the namespace stylesheet



Exception: System.IO.DirectoryNotFoundException

Ein Teil des Pfades C:\Dokumente und Einstellungen\Documenter\Msdn\xslt\namespace.xslt konnte nicht gefunden werden.





Exception: NDoc.Core.DocumenterException
bei NDoc.Documenter.Msdn.MsdnDocumenter.Build(Project _project) in C:\Documents and Settings\Administrator\Desktop\NDoc2005\src\Documenter\Msdn\MsdnDocumenter.cs:Zeile 565.

bei NDoc.Gui.BuildWorker.ThreadProc() in C:\Documents and Settings\Administrator\Desktop\NDoc2005\src\Gui\BuildWorker.cs:Zeile 88.

Exception: System.Exception
bei NDoc.Documenter.Msdn.StyleSheetCollection.MakeTransform(String name, XsltResourceResolver resolver) in C:\Documents and Settings\Administrator\Desktop\NDoc2005\src\Documenter\Msdn\StyleSheetCollection.cs:Zeile 115.

bei NDoc.Documenter.Msdn.StyleSheetCollection.AddFrom(String name, XsltResourceResolver resolver) in C:\Documents and Settings\Administrator\Desktop\NDoc2005\src\Documenter\Msdn\StyleSheetCollection.cs:Zeile 96.

bei NDoc.Documenter.Msdn.StyleSheetCollection.LoadStyleSheets(String extensibilityStylesheet) in C:\Documents and Settings\Administrator\Desktop\NDoc2005\src\Documenter\Msdn\StyleSheetCollection.cs:Zeile 58.

bei NDoc.Documenter.Msdn.MsdnDocumenter.Build(Project _project) in C:\Documents and Settings\Administrator\Desktop\NDoc2005\src\Documenter\Msdn\MsdnDocumenter.cs:Zeile 400.

Exception: System.IO.DirectoryNotFoundException
bei System.IO.__Error.WinIOError(Int32 errorCode, String maybeFullPath)

bei System.IO.FileStream.Init(String path, FileMode mode, FileAccess access, Int32 rights, Boolean useRights, FileShare share, Int32 bufferSize, FileOptions options, SECURITY_ATTRIBUTES secAttrs, String msgPath, Boolean bFromProxy)

bei System.IO.FileStream..ctor(String path, FileMode mode, FileAccess access, FileShare share, Int32 bufferSize)

bei System.Xml.XmlDownloadManager.GetStream(Uri uri, ICredentials credentials)

bei System.Xml.XmlUrlResolver.GetEntity(Uri absoluteUri, String role, Type ofObjectToReturn)

bei NDoc.Core.XsltResourceResolver.GetEntity(Uri absoluteUri, String role, Type ofObjectToReturn) in C:\Documents and Settings\Administrator\Desktop\NDoc2005\src\Core\XsltResourceResolver.cs:Zeile 138.

bei NDoc.Documenter.Msdn.StyleSheetCollection.MakeTransform(String name, XsltResourceResolver resolver) in C:\Documents and Settings\Administrator\Desktop\NDoc2005\src\Documenter\Msdn\StyleSheetCollection.cs:Zeile 105.


Moderiert von user profile iconTino: Quote-Tags hinzugefügt.


Kha - Do 18.01.07 13:32

Die Lösung findest du auf der SF-Seite, allerdings scheint das Projekt genauso tot wie das Original zu sein. Glücklicherweise bastelt Microsoft selbst derzeit an einer Alternative: SandCastle. Erfahrungen habe ich damit aber noch nicht gesammelt.


Delete - Do 18.01.07 17:08

installiere GhostDoc um die Kommentare schnell einzufügen. Dann kannst du mit Sandcastle und dem Sandcastle Helpfile Builder deine Hilfedatei erstellen.


winx - Do 18.01.07 18:21

wie genau funktioniert das mit gohstdoc und sandcastle?


Delete - Do 18.01.07 22:25

GhostDoc fügt die XML-SummaryTags automatisch ein und Sandcastle ist halt wie nDOC, es generiert aus der XML-Datei die Hilfe.


winx - Fr 19.01.07 14:58

versteht ich :-)

hab auch schon ghostdoc, sandcastle und den sc helpfile builder installiert und getestet, bekommaber immer die fehlermeldung:

Zitat:
BUILD FAILED: Unable to find XML comments file: Unknown.xml


was soll ich denn nun damit anfangen ?!?

Moderiert von user profile iconTino: Quote-Tags hinzugefügt.


Delete - Fr 19.01.07 22:22

hast du auch die richtige XML-Datei ausgewählt?


winx - Fr 19.01.07 22:38

ich hab ne dll:

remotecontrol.dll, die nutzt wiederum ne alte (delphi-com) mark.dll. Von der alten hab ich kein XML Help File, deshalb hat er das unknown.xml genommen und nicht gefunden.

Ich möchte aber nur die Kommentare der remotecontrol.dll erzeugen, die andere soll er gar nicht nehmen. bekomm aber immer, wenn ich nur die remotecontroll.dll einbinde, den fehler:
Zitat:
MrefBuilder (v2.2.61208.1447)
Copyright ¸ Microsoft 2006
Error: Unresolved assembly reference: Interop.Mark (Interop.Mark, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null) required by RemoteControl


BUILD FAILED: Unexpected error in last build step. See output above for details.

Haste ne Ahnung, wie ich das hinbekomm???

DANKE!!!

Moderiert von user profile iconTino: Quote-Tags hinzugefügt.


Delete - Mo 22.01.07 09:16

hmm, ich benutze keine COM-Referenzen, deshalb hatte ich das noch nicht, sorry :(