Hålla underhålla källkod är en av de svåraste utmaningarna för alla programutvecklare , om en ensamvarg programmerare eller en medlem av ett stort team . Doxygen kan du generera dokumentation automatiskt från C + + , Java , eller annan kod . Det kommer att analysera din papperslösa kod och skriva grundläggande dokumentation , och du kan lägga speciellt formaterade kommentarer till din källkod för att göra användare tillägg till den genererade källkoden . Saker du behöver
Källkod
Textredigeraren
Visa fler instruktioner
1
Ladda ner och installera Doxygen . Den finns på stack.nl /~ Dimitri /doxygen /download.html # latestsrc .
2
Öppna Kommandotolken . I Windows XP kan du göra detta genom att klicka på Start-menyn , välja Kör , skriva in " cmd " och klicka på OK . I Mac OS kan du klicka på Spotlight -menyn , typ Terminal , och välj Terminal när det visas . Navigera kommandotolken för att din källkod katalog genom att skriva " cd " följt av namnet på katalogen och trycka på Enter .
3
Skapa en Doxyfile genom att skriva " doxygen - g " och trycka Enter . Detta kommer att generera en fil i den aktuella katalogen som heter " Doxyfile , " som kommer att innehålla alla alternativ standard Doxygen . Du kan ändra de här alternativen genom att öppna Doxyfile i en textredigerare .
4
Lägg Doxygen kommentarer till din källkod . Doxygen kommentarer är vanliga kommentarer som innehåller särskilda kommentarer som gör Doxygen att hitta dem och ange hur den ska använda dem . Till exempel , om du skriver in ett C -liknande språk , kan du lägga till en kort beskrivning till en funktion genom att följande kommentarer innan sin förklaring :/* ! \\ kortfattad Mitt kort beskrivning * /Du kan se alla andra anteckningar Doxygen stöder på stack.nl /~ Dimitri /doxygen /docblocks.html .
5
Type " doxygen Doxyfile " på kommandoraden och tryck på Enter . Detta kommer att generera dokumentationen för din källkod .
