.Net XML kommentar til API-dokumentasjon

stemmer
15

Finnes det en enkel måte å produsere MSDN-stil dokumentasjon fra Visual Studio XML utgang?
Jeg er ikke tålmodig nok til å sette opp en god XSLT for det fordi jeg vet at jeg ikke er den første personen til å krysse denne broen.

Også prøvde jeg å sette opp sandslott nylig, men det har virkelig gjort mine øyne korset. Enten jeg manglet noe viktig i prosessen, eller det er bare altfor involvert.

Jeg kjenner noen der ute har en veldig fin dead-enkel løsning.

Jeg gjentok her fordi jeg tror min formatering gjort som ledd ikke innbydende å lese:

Jeg ga sandslott et forsøk, men hadde en veldig vanskelig tid å få det satt opp. Det jeg egentlig har i tankene er noe mye enklere.

Det vil si, med mindre jeg bare ikke forstå sandslott prosessen. Det virket som en forferdelig mye ekstra bagasje til meg bare for å produsere noe fint for testere å jobbe med.

Publisert på 03/08/2008 klokken 22:03
kilden bruker
På andre språk...                            


6 svar

stemmer
9

Du leter etter Sandcastle

Prosjekt Side: Sandcastle utgivelser

Blogg: Sandcastle bloggen

NDoc Kode Dokumentasjon Generator for .NET pleide å være førstevalget, men støtten har alle, men stoppet.

Svarte 03/08/2008 kl. 22:12
kilden bruker

stemmer
5

Du bør også bruke Sandcastle Help File Builder. Den gir deg en ndoc som GUI for å generere hjelpefilene slik at du ikke trenger å gjøre alt fra en ledetekst.

Velkommen til Sandcastle hjelpefilen Builder-prosjektet

Svarte 19/09/2008 kl. 15:22
kilden bruker

stemmer
5

Ta en titt på Sandcastle , som gjør akkurat det. Det er også en av de mer enklere løsninger der ute, og det er mer eller mindre verktøyet av valget, så i det lange løp, kanskje vi kan hjelpe deg med å sette opp Castle hvis du angir hvilke saker det oppstod under installasjonen?

Svarte 03/08/2008 kl. 22:14
kilden bruker

stemmer
4

Følg denne enkle 5 vise artikkelen , og du er ganske mye gjort. Som en bonus kan du bruke H2Viewer til å vise HTML-hjelp 2.x-filer.

Svarte 04/08/2008 kl. 10:31
kilden bruker

stemmer
4

Jeg har nettopp satt opp Sandcastle igjen. Prøv å installere den (utgitt i mai 2008) og søk etter SandcastleGui.exe eller noe lignende (det er i eksemplene mappe eller så).

Klikk Legg Montering og legge til Assembly eller Assemblies, legge til XML dokumentasjonsfiler (som genereres av kompilatoren hvis du har aktivert det alternativet) og deretter bygge.

Det vil ta litt tid, men resultatet vil være verdt innsatsen. Det vil faktisk slå opp ting fra MSDN, slik at resulterende dokumentasjon vil også ha klasse Arv hele veien ned til System.Object med lenker til MSDN og sånt.

Sandcastle virker litt komplisert i starten, spesielt når du ønsker å bruke den i en automatisert bygge, men jeg er helt sikker på at det vil være verdt innsatsen.

Også ta en titt på Sandcastle Help File Builder , dette er en noe mer avansert GUI for det.

Svarte 04/08/2008 kl. 10:27
kilden bruker

stemmer
2

Jeg bruker NDoc3

Svarte 21/02/2010 kl. 22:12
kilden bruker

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more