Informationen zum Sandcastle-Dokumentation Projekt?

Question

Hallo zusammen,

ich verwende in meinen Projekte gerne den Sandcastle-Projekttyp zur Dokumentation des Codes.

Nun sehe ich, dass es doch ziemlich starke Möglichkeiten gibt auch eigene Texte zu hinterlegen, Stichwort "HowTo" oder ähnliches. Diese Texte werden alle in "aml"-Dateien gespeichert, welche letztlich XML-Dateien sind.

Gibt es eine Doku darüber, welche Möglichkeiten das System bietet? Die Dateien beinhalten alle das xmlns-Flag: "xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5", doch es sieht so aus, als wäre dieser Namespace gar nicht gültig. Ich hätte halt gerne mal eine Übersicht gehabt. Man kann zwar viel durch Ausprobieren erfahren, aber eine Doku wäre natürlich Spitze.

Hat jemand Erfahrungen damit?

Gruß, Karsten.

Answer 1

Hallo Karsten,

Nachdem Du XML-Kommentare in Deinem Projekt aktiviert und einige Kommentare zu Deinem Code hinzugefügt hast, kannst Du Dein erstes Hilfedatei-Builder-Projekt erstellen. Hast Du XML-Kommentare in Deinem Projekt aktiviert? Weitere Informationen findest Du im folgenden Github-Artikel:
Sandcastle Help File Builder (SHFB) > Getting Started > Enabling and Using XML Comments

Gruß,

Ivan Dragov

---

Bitte haben Sie Verständnis dafür, dass im Rahmen dieses Forums, welches auf dem Community-Prinzip „IT-Pros helfen IT-Pros“ beruht, kein technischer Support geleistet werden kann oder sonst welche garantierten Maßnahmen seitens Microsoft zugesichert werden können.

Answer 2

Hallo Iwan,

die XML-Kommentare kannte ich schon, was ich gesucht hatte, war die Doku zur MAML-Syntax, die aber in deinem Link enthalten ist. Diesen Link hier habe ich gebraucht: MAML-Guide. Mittlerweile habe ich auch das alles als PDF gefunden, was auch sehr praktisch ist: MAML als PDF.

Gruß, Karsten.