Startseite > Archiv > .NET-Code dokumentieren mit Sandcastle und MAML

.NET-Code dokumentieren mit Sandcastle und MAML

dotnetpro 12/2008 Von Golo Roden erschienen in dotnetpro 12/2008 auf Seite 72
Code: A0812Sandcastle
3 Bewertung(en):

Seit der ersten Version bietet C# die Möglichkeit, eigenen Code mit Anmerkungen im Stil einer Referenzdokumentation zu versehen. Allerdings fehlte zum einen lange Zeit ein Werkzeug, um diese Kommentare in eine menschenlesbare Form zu bringen, zum anderen war es nicht möglich, Endbenutzerdokumentation zu erzeugen. Besserung ist in Sicht.

Artikel Download

Als Abonnent können Sie den gesamten Artikel als PDF abrufen und die zugehörigen Quelltexte direkt downloaden.

Sie sind bereits Abonnent? Dann registrieren Sie Ihr Abonnement jetzt online und greifen Sie sofort auf das komplette Artikelarchiv zu.

Einzelheft-Bestellung

Sie interessieren sich für diesen Artikel und haben noch kein Abonnement? Dann bestellen Sie doch einfach diese Ausgabe der dotnetpro als Einzelheft.

Abo-Bestellung

Probeabo
Wenn Sie die dotnetpro kennenlernen wollen, ist das Probeabo genau richtig für Sie. Lesen Sie die aktuelle sowie die kommende Ausgabe zu einem besonders günstigen Preis.








Abo
Wenn Sie die neue Ausgabe der dotnetpro als Erster lesen wollen, dann liegen Sie mit einem Abo genau richtig – zwölf Mal pro Jahr druckfrisch in Ihrem Briefkasten und das noch bevor das Heft am Kiosk erhältlich ist.

Sie finden diesen Artikel interessant? Dann helfen Sie anderen ihn zu finden und kicken Sie ihn bei www.dotnet-kicks.de!

Tags

00e97994   084dnp_sandcastle2_jp   10115   1970er   1999   2003   2005   2006   2008   46e0   5be86b2f8278   A0610Dokumentation   A0812Sandcastle   Abbildung   aber   ablegt   Absatz   abstract   abzulegen   Additional   Adresse   Ähnlichem   aktuellen   Algorithmen   alle   allem   aller   Allerdings   allgemeinen   allgemeingültige   also   Alternate   ande   anderen   Ändern   anders   Änderungsdatum   anfallen   Anfang   ange   angegeben   angepasst   angesehen   angewiesen   Ankündigung   Anmerkungen   anpassen   Ansatz   Anwenderdokumentation   Anwenderdokumentationen   Anwendungsfälle   anzupassen   anzutreffen   apiDocs   Application   Applikationsarchi   Arbeit   arbeiten   Arten   Assemblies   Assistance   auch   audio   Aufbau   aufbereite   Aufgabe   aufgebaut   Ausfüh   ausführen   Ausführung   Ausgabe   Ausgabefor   Ausgabeformate   Ausgabeord   ausgesprochen   ausschließlich   außer   Außerdem   äußerst   Auszeichnung   auszutauschen   authoring   Auto   automatisch   automatischen   automatisiert   Autor   Autorenteam   Autors   b420   Basic   Basis   Bedarf   bedeutet   Bedeutung   Bedienung   Begriff   behandeln   beheben   Beide   beiden   Beispiel   Beispiele   beispielsweise   beispielsweiseTutorials   beitung   bekann   beliebigen   Benutzeroberfläche   bereit   bereits   berrechtshinweise   berücksichtigt   berücksichtigten   beschäftigt   beschränken   beschreiben   Beschreibungen   beschrieben   Beson   besser   besserung   besteht   bestimmte   bewirkt   bezeichnet   bietet   Bilder   Bisher   bislang   Blabla   blemlos   Blick   Bord   Breisgau   bringen   bringt   Buil   Build   Builder   Building   buildInstructions   Builds   Castle   chen   class   Code   Codebeispiele   codeEntityReference   codeExample   codeplex   Codes   Collie   Commenting   Community   Compiler   Compilertechnologien   Computer   Conceptual   content   contents   crosofts   ctor   dabei   dagegen   daher   Danach   dann   dard   darzustellen   dass   Dateien   dazu   ddue   Definition   dene   dere   derem   deren   derheiten   ders   dersprach   derzeit   desCodes   Design   Designs   dest   deutlich   developerHowToDocument   Dialekt   dienen   dient   dies   diese   diesem   diesemWeg   diesen   dieser   dieses   dieVer   Digita   dings   discussion   dnpCode   documentation   Doku   Dokumentarten   Dokumentation   Dokumentationen   Dokumentationsdatei   Dokumentationsdateien   Dokumente   Dokumenten   dokumentieren   dokumentiert   Donald   dotnetpro   Download   dozeile   drei   durch   durchdreianstellederüblichenzweiSchrägstriche   dürfte   dürftig   e9e6   ebenfalls   Editor   egal   eher   eigene   eigenen   eigenes   eignen   einbetten   Einbinden   eine   einem   einen   einer   eines   einfach   einfacher   eingeleitet   eingestelltes   einheitlichen   einige   einigen   einiges   einigeWochen   einschließlich   Einstellung   einVerweis   einWerkzeug   einzige   einzubinden   einzufügen   Eisbären   elektronischer   Elemente   Elements   Encoding   Endanwender   Endbenutzerdokumentation   Engineering   enthält   enthalten   enthaltenen   enthielt   Entitäten   Entity   entsprechen   entsprechend   entsprechenden   entstanden   entste   entweder   Entwick   Entwickeln   entwickelt   Entwickler   Entwicklung   erfüllt   ergänzen   erlangte   erläutern   erläuternde   ermöglichen   ermöglicht   erreichen   Error   erstaunlich   erste   erstellen   ersten   Erster   erstmals   Ervin   Erweiterbarkeit   erweitert   erzeugen   erzeugte   erzeugten   erzwin   erzwingt   etwa   Example   examples   Excel   Executes   external   externalLink   externe   facto   fasst   Fazit   fehlte   fend   fentlichen   ferenzdokumentation   fernen   fertig   File   finden   Findet   fine   Firma   First   FirstMethod   Fließtexte   Fokus   Folge   folgte   followed   following   förder   Form   Format   formationen   fortge   Fotografie   Frameworks   Freiburg   Freizeit   fügung   funktio   gängigen   gänzt   gebaut   gehören   geisterung   gekennzeichnet   gemein   genau   generator   generell   generierte   generischenTypen   genschaft   genutzt   gerade   geraumer   geschaffen   gescheitert   geschrieben   gesetzt   gesichert   gespeichert   getrennt   gewählten   gewesen   gewisse   geworden   gibt   giert   gilt   gleiche   gleichen   glieder   Glossareinträge   Golo   grafische   grammierens   größere   Grund   Grundlagen   grundlegende   Grundstruktur   GUID   Guide   haben   Handbuch   handelt   Handling   häufig   häufigsten   have   hebt   help   Herange   here   heute   hier   hierfür   Hilfe   Hilfedateien   Hilfesystems   Hinter   hinzuzufügen   Hochkommas   Howtos   href   HTML   HTTP   hungsprozesses   ideal   Idee   IDEs   ihrem   ihren   Ihrer   immer   Immerhin   indem   Informationen   Infrastruktur   Inhalt   innerhalb   Insbeson   Insbesondere   INSERT   Instructions   Int32   Integra   Integration   Integrierbarkeit   integrierte   integrierten   intensiv   interessant   interne   Internet   Introduction   inzwischen   issues   Jahren   Januar   jeden   jedoch   jeglicher   jekt   jeweiligen   jeweils   Juli   JUNI   kann   Karte   Kategorien   kein   keine   keineswegs   kennzeichnen   kennzeichnet   Kern   Kinderschuhen   Klasse   Klassen   klassische   klassischen   klassischerweise   Klassisches   klassischeTextverarbeitungssysteme   Knuth   Kochen   Komman   Kommandozei   kommen   Kommenta   Kommentar   Kommentare   Kommentaren   kommentieren   kompilierten   können   konnte   Konvertertool   konvertiert   kumentation   Kürzel   kürzungen   lange   länger   Language   lässt   Lauf   Layout   least   lebt   lediglich   leichten   Leistung   lenwerkzeugen   lerdings   lesbar   lesbares   Lesbarkeit   letztauchdasDokumentierenundKommentieren   letztlich   Lexware   lich   liegt   ließen   Linie   Link   linkAlternateText   links   Linktext   linkUri   Listing   literarischen   Lizenzbedingungen   Local   Lohrer   Lücke   lungsumgebungen   machen   macht   mächtige   Mail   Main   MAML   mandozeile   mandozeilenwerkzeug   Manko   manuelle   markieren   markiert   Markup   mary   matiert   matisierten   Matthias   Mechanismen   Mechanismus   Medien   Medienelemente   mehr   meisten   meistens   Member   Menschen   menschenlesbare   mentare   mentation   mente   mentieren   ments   Metadaten   meter   Methode   Methoden   Micro   Microsoft   miersprachen   mithilfe   mittelfristig   Mitteln   moderne   modernere   Modus   möglich   Möglichkeit   Möglichkeiten   more   msdn   Musik   muss   müsse   musste   Must   nach   nachdem   Nachhinein   Namen   Namens   Navigation   NDoc   Neben   neln   nerhalb   nicht   Nightly   noch   Nomenklatur   nommen   notwendig   notwendigen   obigen   obwohl   oder   öffentlich   oftware   Open   Optik   optimiert   Optimierung   Option   optional   Optionen   optisch   ordered   other   Paket   Para   Parameter   Parametern   Peng   Pfad   PostSharp   PowerShell   Präfix   praktisch   Praxis   Prinzip   Prinzipiell   problemlos   PROCEDURE   Procedures   Program   Programmierer   Projekt   Projekteigen   Projekteigenschaften   Projekten   Projekts   propa   Prozess   prüft   public   Punkt   puterprogramme   QdnpCode   QdnpLinkSL0812Sandcastle1   QdnpLinkSL0812Sandcastle2   QdnpLinkSL0812Sandcastle3   Quellcode   Quellcodes   Rahmen   rater   redaktionell   redaktioneller   Refe   Reference   Referenz   Referenzdo   Referenzdoku   Referenzdokumentation   Referenzen   Regel   registrieren   reine   reines   related   relatedTopics   renzdokumentation   represents   Required   Ressourcen   Richtschnur   riert   robustProgramming   Roden   Rückgabewert   Rückgabewerten   Sand   Sandcastle   SandcastleStyles   Satz   schaften   schemas   schen   schiedene   schiedlich   schlechter   schlichten   schon   schrei   schreiben   Schreibweise   schrittenen   Schwäche   Second   SecondMethod   Security   Sehr   sein   seine   seinen   seiner   Seit   seitdem   Seite   seitenübergrei   selbst   setzt   SHFB   sich   sicher   sichern   Sicht   sichtbaren   sind   Situation   Skript   Skripte   sodass   soft   Software   Softwaredoku   sogenanntem   sogenannten   solche   Solid   soll   sollten   some   SomeProperty   sonderlich   sondern   source   sourceforge   sowie   sowohl   später   späteren   spezielle   Spezifikationen   spielhafte   spielsweise   Sprache   sprachen   stan   Stand   static   Statt   stecken   steht   steigenderVerbreitung   Stelle   stellen   stellt   Step   Steps   steuern   stiefmütterlich   Stil   Stile   string   Struktu   Struktur   stützen   Styles   SUMMARY   system   systematische   Szenario   tagesaktuelle   Tags   tare   Teammit   Teams   Technologiebe   Technologien   Teil   teilt   tektur   temen   tert   TestClass   TestDoc   teste   testen   Text   Textauszeichnung   Themas   Themen   these   tieren   tion   title   Tochter   TODO   Tool   Topic   ToString   Tutorials   Typen   Typs   über   Überarbeitung   überführen   übergeben   überhaupt   übliche   üblicher   übrigens   umbraco   Umgang   umgehen   umgekehrt   Umset   umzuwandeln   undTipps   undVisual   unstrukturiert   unter   unterscheiden   unterscheidet   unterschieden   unterstützen   unterstützt   Urhe   Variante   verändert   verar   verarbeiten   verbessern   verfügbar   verfügbaren   verfügen   Verfügung   Verlauf   verlinken   vermutlich   vernünftigen   veröf   Veröffentlichung   verschie   verschiede   verschiedene   verschlech   versehen   Version   versteht   Versuch   versus   verteilbares   vertretene   verwaltete   Verweis   verweisen   verwenden   verwendet   verwendete   verwendeten   Verwendung   verwiesen   Videos   vielen   vigation   Vista   Visual   void   vollständig   vollzieht   Vorgang   vorgestellt   vorhanden   Vorlage   Vorlagen   vorliegt   Während   WährendderBegriffDokumentationin   walteten   wäre   wart   Warten   Websei   Webseiten   Webstil   weise   weisen   Weiterentwicklung   welche   welches   wenderdokumentationen   wendung   wenig   wenige   wennfürvieleEntwicklerdasProgrammie   werden   Werkzeug   Werkzeuge   Wermutstropfen   wesentlich   wichtig   wichtige   wikipedia   WINDOWS   wird   wobei   woran   Word   Writing   wurden   WYSIWYG   xlink   xmlns   zahlreiche   zahlreichen   zeichnet   Zeit   Zeitpunkt   zentraler   Zentrum   Ziels   Zielthe   zogenen   Zudem   zuerst   Zukunft   zukünftig   zumin   zunächst   zungen   zusammen   Zusätzlich   zusätzliche   zustellen   zuwählen   Zwar   Zweck   zwei   zwischen

Login
Sie sind nicht eingeloggt.

Login & Registrierung
Abo bestellen





Anzeige





Newsletter
Tragen Sie Ihre E-Mailadresse für den kostenlosen Newsletter von dotnetpro ein.


Umfrage
Wie zufrieden sind Sie mit Ihrem Gehalt?




Ergebnis anzeigen