Holde kildekoden vedlikeholdsvennlig er en av de vanskeligste utfordringene som noen programvareutvikler , om en ensom ulv programmerer eller et medlem av et stort team . Doxygen lar deg generere dokumentasjon automatisk fra C + + , Java , eller annen kode . Det vil analysere udokumentert kode og skrive grunnleggende dokumentasjon , og du kan legge spesielt formaterte kommentarer til kildekoden for å gjøre nyttige tilskuddene til den genererte kildekoden. Du trenger
Kildekode
Text Editor
Vis flere instruksjoner
en

Last ned og installer Doxygen . Den er tilgjengelig på stack.nl /~ dimitri /doxygen /download.html # latestsrc .
2

Åpne et ledetekst . På Windows XP kan du gjøre dette ved å klikke på Start-menyen , velge Kjør , skrive inn " cmd" , og klikke på OK. På Mac OS , kan du klikke på Spotlight -menyen, skriver Terminal , og velg Terminal når den vises. Naviger ledeteksten til kildekoden katalogen ved å skrive " cd " etterfulgt av navnet på katalogen og trykke Enter.
3

Lag en Doxyfile ved å skrive " doxygen - g " og trykke Enter. Dette vil generere en fil i gjeldende katalog som heter " Doxyfile ", som vil inneholde alle standard Doxygen alternativer. Du kan endre disse alternativene ved å åpne Doxyfile i en tekst editor.
4

Legg Doxygen kommentarer til kildekoden. Doxygen kommentarer er normale kommentarer som inneholder spesielle merknader som gjør Doxygen å finne dem og å beskrive hvordan den skal bruke dem . For eksempel , hvis du skriver i en C - stil språk, kan du legge til en kort beskrivelse til en funksjon ved å tilføye følgende kommentar før sin erklæring :/* ! \\ kort Mitt kort beskrivelse * /Du kan se alle de andre merknader Doxygen støtter på stack.nl /~ dimitri /doxygen /docblocks.html .
5

Type " doxygen Doxyfile " på din kommando prompt og trykk på Enter. Dette vil generere dokumentasjon for kildekoden.