Dator > hur man använder doxygen att skriva källkoder

  • hur man använder doxygen att skriva källkoder


  • Att hålla källkoden underhållbar är en av de svåraste utmaningarna för alla mjukvaruutvecklare , om en ensam varg programmerare eller en medlem av en stor grupp . Doxygen låter dig skapa dokumentation automatiskt från C + + , Java , eller annan kod . Det kommer att analysera dina papperslösa kod och skriva grundläggande dokumentation , och du kan lägga speciellt formaterad kommentarer till din källkod för att göra nyttiga tillägg till den genererade källkoden

    Du behöver : .
    Källkod
    Textredigeraren .


    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 "cmd " och klicka på OK. I Mac OS kan du klicka på Spotlight -menyn, skriv Terminal och välj Terminal när det visas . Navigera kommandotolken till 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 på Enter . Detta kommer att generera en fil i den aktuella katalogen heter " Doxyfile ", som kommer att innehålla alla de förvalda Doxygen alternativ . Du kan ändra dessa alternativ genom att öppna Doxyfile i en textredigerare .
    4 .
    Lägg Doxygen kommentarer till din källkod . Doxygen kommentarer är normal kommentarer som innehåller speciella kommentarer som gör Doxygen att hitta dem och ange hur den ska använda dem . Till exempel , om du skriver i ett C -liknande språk kan du lägga till en kort beskrivning till en funktion genom att lägga till följande kommentar innan sin förklaring :
    /* ! \ kortfattad Mina kort beskrivning * /
    Du kan se alla andra kommentarer Doxygen stöder på stacken . NL /~ Dimitri /doxygen /docblocks. html .
    5 .
    Typ " doxygen Doxyfile " på ditt kommando prompten och tryck Retur . Detta kommer att generera i dokumentationen till din källkod .


Previous:Vilka är fördelarna med Java uppgradera ? Next:Visual Basic datatyper





Relaterade artiklar


  • HP 8700 specs
  • hur man använder en LCD-skärm med en stationär
  • arbetsbeskrivning för en CMM programmerare
  • hur du ställer svart bläck bara på en Epson Photo R200
  • Ta bort en bild från din dator
  • hur man kan stoppa en oändlig slinga
  • hur du ställer in korseld
  • hur man kan förlänga livet för en överföringsrulle
  • hur man överklockar ett EVGA 650i
  • hur man fixar en inverter styrelse