.Net comentariu XML în documentația API

Există o modalitate ușoară de a produce documentație în stil MSDN din ieșirea xml Visual Studio ?. Nu sunt destul de răbdătoare pentru a stabili un bun xslt pentru asta, deoarece știu că nu sunt prima persoană care trec peste acest pod.

De asemenea, am încercat să instalez recent sandcastle, însă mi-a făcut ochii încrucișați. Ori am pierdut ceva important în acest proces sau este prea mult implicat.

Știu că cineva acolo are o soluție drăguță și foarte simplă.

Reiterez aici pentru că cred că formatarea mea a făcut paragraful care nu este invitat să citească:

Am dat o încercare lui sandcastle, dar a avut un timp foarte greu să-l înființez.   Ceea ce am în minte este ceva mult mai simplu.

Asta este, dacă nu înțeleg procesul sandcastle. Părea ca o grămadă de bagaje suplimentare pentru mine doar pentru a produce ceva frumos pentru testeri să lucreze cu.

 0
adăugat editat
Vizualizări: 62
sursa
fr zh hi bn

6 răspunsuri

Urmați acest articol simplu din 5 pași și sunteți destul de mult făcut. Ca bonus, puteți folosi H2Viewer pentru a vedea fișierele Html Help 2.x.

0
adăugat
sursa

Aruncați o privire la Sandcastle , care face exact acest lucru. Este, de asemenea, una dintre soluțiile mai simple și este mai mult sau mai puțin instrumentul de alegere, astfel încât, pe termen lung, poate vă putem ajuta să configurați Sandcastle dacă specificați problemele pe care le-ați întâmpinat în timpul instalării?

0
adăugat
sursa

Tocmai am înființat Sandcastle. Încercați să îl instalați (versiunea din mai 2008) și căutați SandcastleGui.exe sau ceva similar (este în dosarul de exemple sau așa).

Faceți clic pe Adăugați Adunare și adăugați Adunarea sau Asamblările, adăugați fișierele de Documentație xml (cele generate de compilator dacă ați activat acea opțiune) și apoi Build.

Va dura ceva timp, dar rezultatul va fi meritat efortul. Acesta va căuta de fapt lucruri de la MSDN, astfel încât documentația rezultată va avea, de asemenea, clasa Moștenire până la System.Object cu link-uri către MSDN și alte chestii.

Sandcastle pare un pic cam complicat la început, mai ales când doriți să îl utilizați într-o construcție automatizată, dar sunt absolut sigur că va merita efortul.

De asemenea, aruncați o privire la Sandcastle Help Builder , acesta fiind un GUI ceva mai avansat pentru el.

0
adăugat
sursa

Căutați Sandcastle

Project Page: Sandcastle Releases

Blog: Sandcastle Blog

NDoc Code Documentation Generator for .NET used to be the tool of choice, but support has all but stopped.

0
adăugat
sursa
Încercați sourceforge.net/projects/ndoc3
adăugat autor Muxa, sursa

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

Bine ați venit în proiectul Sandcastle Help Builder

0
adăugat
sursa

I use NDoc3

0
adăugat
sursa