NET XML kommentaar in API dokumentasie

Question

Is daar 'n maklike manier om MSDN-styl dokumentasie produseer van die Visual Studio XML uitvoer?
Ek is nie genoeg om 'n goeie XSLT vir dit, want ek weet ek is nie die eerste persoon om hierdie brug oorsteek pasiënt.

Ook, het ek probeer om die oprigting van 'sandkasteel onlangs, maar dit is werklik gemaak my oë kruis. Óf ek mis iets belangrik in die proses of dit is net heeltemal te betrokke.

Ek weet iemand daar buite het 'n baie mooi dood-eenvoudige oplossing.

Ek is hier herhaal, want ek dink my opmaak gemaak dat paragraaf nie-nooi om te lees:

  

Ek het sandkasteel probeer maar het 'n baie harde tyd om dit opgestel.   Wat ek regtig in gedagte is iets baie makliker.

Dit is, tensy ek net nie die sandkasteel proses verstaan. Dit het gelyk soos 'n vreeslike lot van ekstra bagasie na my net iets lekker vir die testers om te werk met te produseer.

Answer 1

Jy is op soek na Sandkasteel

Project Page: Sandkasteel Releases

blog: Sandkasteel Blog

NDoc Kode Dokumentasie Generator vir NET gebruik word om die instrument van keuse wees, maar steun het al, maar gestop .

Answer 2

Het jy 'n blik op Sandkasteel , wat presies dit doen. Dit is ook een van die meer eenvoudiger oplossings daar buite, en dit is min of meer die instrument van keuse, so in die lang termyn, miskien kan ons jou help om op te rig Sandkasteel as jy spesifiseer watter kwessies jy teëgekom tydens die installasie?

Answer 3

Jy moet ook die Sandkasteel hulplêer Bouwer. Dit bied jou met 'n ndoc soos GUI vir die opwekking van hulp-lêers, sodat jy hoef nie om iets uit 'n opdrag prompt doen.

Welkom by die Sandkasteel hulplêer Bouwer Projek

Answer 4

Volg hierdie eenvoudige 5 stap artikel en jy pretty much gedoen. As 'n bonus wat jy kan gebruik H2Viewer om HTML Help 2.x lêers te besigtig.

Answer 5

Ek het net die opstel van Sandkasteel weer. Probeer die installering van dit (die Mei 2008 uitgawe) en soek vir SandcastleGui.exe of iets soortgelyks (dis in die voorbeelde gids of so).

Klik Voeg Vergadering en voeg jou Vergadering of gemeentes, voeg enige Xml Dokumentasie lêers (dié wat gegenereer word deur die samesteller as jy daardie opsie geaktiveer) en dan bou.

Dit sal 'n rukkie neem, maar die resultaat sal wees die moeite werd. Dit sal eintlik opkyk dinge van MSDN, so jou lei dokumentasie sal ook die Klas Erfenis al die pad af na System.Object met skakels na MSDN en dinge.

Sandkasteel lyk 'n bietjie ingewikkeld op die eerste, veral as jy wil om dit te gebruik in 'n outomatiese bou, maar ek is seker dit sal die moeite werd wees.

het ook 'n blik op Sandkasteel Hulp lêer Bouwer , dit is 'n bietjie meer gevorderde GUI vir dit .

Answer 6

Ek gebruik NDoc3