Holde kildekode vedligeholdelsesvenlig er en af ​​de mest vanskelige udfordringer enhver softwareudvikler, hvorvidt en ensom ulv programmør eller et medlem af en stor team. Doxygen kan du generere dokumentation automatisk fra C + + , Java eller anden kode . Det vil analysere din udokumenterede kode og skrive grundlæggende dokumentation , og du kan tilføje specielt formaterede kommentarer til din kildekode til at gøre nyttige tilføjelser til den genererede kildekode. Ting du skal
Kildekode
Text Editor
Vis Flere Instruktioner
1

Download og installer Doxygen . Den findes på stack.nl /~ dimitri /doxygen /download.html # latestsrc .
2

Åbn en kommandoprompt. På Windows XP kan du gøre dette ved at klikke på Start Menu , vælge Kør , skrive " cmd" , og klikke på OK. På Mac OS , kan du klikke på Spotlight-menuen , type Terminal, og vælg Terminal når den vises. Naviger kommandoprompten til din kildekode mappe ved at skrive " cd " efterfulgt af navnet på mappen og trykke på Enter.
3

Opret en Doxyfile ved at skrive " doxygen - g ", og trykke på Enter. Dette vil generere en fil i den aktuelle mappe kaldet " Doxyfile ", som vil indeholde alle de standard Doxygen muligheder. Du kan ændre disse indstillinger ved at åbne Doxyfile i en teksteditor .
4

Tilføj Doxygen kommentarer til din kildekode. Doxygen kommentarer er normale kommentarer, der indeholder specialtegn anmærkninger , der giver Doxygen at finde dem og angive, hvordan det skal bruge dem. For eksempel, hvis du skriver i en C -style sproget kan du tilføje en kort beskrivelse til en funktion ved at tilføje følgende bemærkning før sin erklæring :/* ! \\ kortfattet My kort beskrivelse * /Du kan se alle de andre anmærkninger Doxygen understøtter på stack.nl /~ dimitri /doxygen /docblocks.html .
5.

Type " doxygen Doxyfile " på din kommando prompt og trykke på Enter. Dette vil generere dokumentationen til kildekode.