Het houden van de broncode te onderhouden is een van de moeilijkste uitdagingen voor elke software-ontwikkelaar , of een eenzame wolf programmeur of een lid van een groot team . Doxygen kunt u automatisch documentatie van C + + , Java , of andere code te genereren . Het zal analyseren uw ongedocumenteerde code en schrijf basisdocumentatie , en je kunt speciaal opgemaakte commentaren toe te voegen aan uw broncode om behulpzaam toevoegingen aan de gegenereerde source code . Wat je nodig hebt
Broncode
Text Editor
Toon Meer Aanwijzingen
Download 1 en installeer Doxygen . Het is beschikbaar op stack.nl /~ dimitri /doxygen /download.html # latestsrc . Kopen van 2 Open een opdrachtprompt . In Windows XP kunt u dit doen door te klikken op het menu Start , Uitvoeren te kiezen , moet u " cmd " en op OK te klikken . Op Mac OS , kunt u op het Spotlight -menu , het type terminal , en kies Terminal wanneer het verschijnt . Navigeer de opdrachtprompt om uw broncode directory door te typen "cd " gevolgd door de naam van de map en druk op Enter .
3 Maak een Doxyfile door te typen " doxygen - g" en druk op Enter . Dit zal een bestand in de huidige directory genaamd " Doxyfile , " waarin alle standaard Doxygen opties zal bevatten genereren . U kunt deze opties wijzigen door het openen van de Doxyfile in een teksteditor .
4 Toevoegen Doxygen commentaar aan uw broncode . Doxygen opmerkingen zijn normale reacties die speciale annotaties waarmee Doxygen om ze te vinden en aan te geven hoe het hen moet gebruiken bevatten . Bijvoorbeeld , als je het schrijven van een C - stijl taal , kunt u een korte beschrijving toe te voegen aan een functie door toevoeging van het volgende commentaar vóór zijn verklaring :/* ! \\ beknopte Mijn korte beschrijving * /Je ziet alle andere annotaties Doxygen ondersteunt bij stack.nl /~ dimitri /doxygen /docblocks.html .
Type " doxygen Doxyfile " 5 op de opdrachtprompt en druk op Enter . Dit zal de documentatie van uw broncode te genereren .
|
