Autor Beitrag
mbraun
Hält's aus hier
Beiträge: 7



BeitragVerfasst: Di 07.08.07 16:36 
Hallo Leute,

ich habe in meinem Programm Kommentare mit

ausblenden C#-Quelltext
1:
2:
3:
        /// <summary>
        /// Test
        /// </summary>


erstellt. Anschließend habe ich unter den Build Setting die Option XML Documentation file aktiviert, sodass ich eine XML Datei bekomme. Aber wie kann ich diese Datei in einem möglichst für den Menschen lesbaren Format anzeigen lassen? Okay, die XML Datei selbst ist lesbar, aber es ist nichts, was man anderen in die Hand drücken kann, damit er weiß, was eine Funktion macht.

Ich habe schon im Netz gesucht und bin dabei über das Stichwort Sandcastle gestolpert. Aber mit der Anwendung kann ich irgendwie nichts anfangen. Kann mir jemand sagen, wie ich am einfachsten eine Doku herstellen kann?


Moderiert von user profile iconChristian S.: Topic aus Sonstiges (C# / .NET) verschoben am Di 07.08.2007 um 17:42
Moderiert von user profile iconChristian S.: Info-Feld gesetzt
Christian S.
ontopic starontopic starontopic starontopic starontopic starontopic starhalf ontopic starofftopic star
Beiträge: 20451
Erhaltene Danke: 2264

Win 10
C# (VS 2019)
BeitragVerfasst: Di 07.08.07 16:41 
Hallo!

Sandcastle alleine ist ziemlich unbenutzbar. Aber es gibt ein paar gute GUIs dazu, ich verwende gerne Sandcastle Help File Builder

Grüße
Christian

_________________
Zwei Worte werden Dir im Leben viele Türen öffnen - "ziehen" und "drücken".
mbraun Threadstarter
Hält's aus hier
Beiträge: 7



BeitragVerfasst: Fr 10.08.07 11:05 
Hi,

ich habe das Ding auch ausprobiert, nur leider funktioniert das nicht ganz. Folgende Meldung erscheint:

ausblenden volle Höhe Quelltext
1:
2:
3:
4:
5:
6:
7:
8:
9:
10:
11:
12:
13:
14:
15:
16:
17:
18:
19:
20:
21:
22:
23:
24:
25:
26:
27:
28:
29:
30:
31:
32:
[Sandcastle Help File Builder GUI, version 1.5.0.1]
Build started at 10.08.2007 11:56:56

Clearing working folder...
Finding tools...
Found Sandcastle in 'C:\Programme\Sandcastle\'
Found HTML 1.x help compiler in 'C:\Programme\HTML Help Workshop\'
Validating documentation assembly information...
-------------------------------
Creating Sandcastle configuration file...
    Last step completed in 00:00:00.0000
-------------------------------
Generating shared content files (en-US)...
    Last step completed in 00:00:00.0000
-------------------------------
Generating reflection information...
[C:\Dokumente und Einstellungen\xxx\Desktop\Help\Working\GenerateRefInfo.bat]
MrefBuilder (v2.2.64000.4)
Copyright ¸ Microsoft 2006
Info: Loaded 8 assemblies for reflection and 0 dependency assemblies.
Info: Wrote information on 16 namespaces, 148 types, and 1306 members
    Last step completed in 00:00:01.4721
-------------------------------
Removing duplicate topics from reflection information file
    0 duplicate topics removed
    Last step completed in 00:00:00.0157
-------------------------------
Generating namespace summary information...
    Last step completed in 00:00:00.0157


BUILD FAILED: Error generating namespace summaries: Das Stammelement ist nicht vorhanden.


Als ich meine Glaskugel in die Werkstatt gebracht habe, habe ich dort auch deine gesehen. Scherz beiseite, du weißt nicht zufällig, woher die Meldung kommt und was ich dagegen unternehmen kann?