comentariu .Net XML în documentația API

voturi
15

Există o modalitate ușoară de a produce documentația MSDN-stil de ieșire Visual Studio XML?
Nu sunt pacient suficient pentru a seta un XSLT bun pentru el , pentru că știu că nu sunt prima persoană să traverseze acest pod.

De asemenea, am încercat înființarea Sandcastle recent, dar într-adevăr a făcut ochii mei cruce. Ori am fost lipsește ceva important în procesul sau este pur și simplu prea implicat.

Știu că cineva acolo are o soluție foarte frumos mort simplu.

Sunt reiterând aici deoarece cred că formatarea mea a făcut ca punctul de bază non-primitoare pentru a citi:

I-am dat Sandcastle o încercare, dar a avut un timp foarte greu să-l configurați. Ceea ce am într-adevăr în minte este ceva mult mai simplu.

Asta este, dacă nu pur și simplu nu înțeleg procesul de Sandcastle. Se pare ca o mulțime de bagaj suplimentar pentru mine doar pentru a produce ceva frumos pentru testeri pentru a lucra cu.

Întrebat 03/08/2008 la 23:03
sursa de către utilizator
În alte limbi...                            


6 răspunsuri

voturi
9

Cauți Sandcastle

Proiect Pagina: Sandcastle de presă

Blog: Sandcastle Blog

NDoc Cod Documentație Generator pentru NET folosit pentru a fi instrumentul de alegere, dar sprijin a oprit toate , dar.

Publicat 03/08/2008 la 23:12
sursa de către utilizator

voturi
5

Ar trebui să utilizați, de asemenea, Sandcastle Builder Help File. Acesta vă oferă un ndoc ca GUI pentru generarea de fișiere de ajutor, astfel încât să nu trebuie să facă nimic de la un prompt de comandă.

Bine ați venit la Ajutor Sandcastle Builder fișier proiect

Publicat 19/09/2008 la 16:22
sursa de către utilizator

voturi
5

Atunci o privire la Sandcastle , care face exact acest lucru. Este , de asemenea , una dintre cele mai simple soluții de acolo, și este mai mult sau mai puțin instrumentul de alegere, astfel încât pe termen lung, poate că am putea ajuta să configurați Sandcastle dacă specificați ce probleme ați întâlnit în timpul instalării?

Publicat 03/08/2008 la 23:14
sursa de către utilizator

voturi
3

Urmați acest simplu articol 5 pas și vă sunt destul de mult de făcut. Ca un bonus , puteți utiliza H2Viewer pentru a vizualiza fișiere 2.x HTML Help.

Publicat 04/08/2008 la 11:31
sursa de către utilizator

voturi
3

Tocmai am înființat Sandcastle din nou. Încercați să instalați-l (lansarea din mai 2008) si cauta SandcastleGui.exe sau ceva similar (e în dosarul exemple sau cam asa ceva).

Faceți clic pe Adăugați și adăugați Adunarea Adunarea sau ansambluri, adăugați orice fișiere .xml documentare (cele generate de compilator dacă ați activat această opțiune) și apoi a construi.

Aceasta va dura ceva timp, dar rezultatul va merita efortul. Se va uita de fapt , chestii de la MSDN, astfel încât documentația rezultată va avea , de asemenea, moștenirea de clasă tot drumul până la System.Object cu link - uri către MSDN și alte chestii.

Sandcastle pare un pic complicat la început, mai ales atunci când doriți să-l folosească într-un construi automat, dar sunt absolut sigur că va merita efortul.

De asemenea , au o privire la Sandcastle Builder Ajutor fișier , acest lucru este o interfață grafică ceva mai avansat pentru ea.

Publicat 04/08/2008 la 11:27
sursa de către utilizator

voturi
2

Eu folosesc NDoc3

Publicat 21/02/2010 la 23:12
sursa de către utilizator

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