A Doxygen egy dokumentáció generáló eszköz, amellyel viszonylag könnyen szinkronban tudjuk tartani a dokumentációnkat a kóddal, mert a dokumentációt a kódba kell írni kommentek formájában. Elég sokféle programozási nyelvet támogat, azonban például Bash szkriptek dokumentálására alapértelmezetten nem képes ez a program.
Kis módosítással azonban írhatunk akár teljes dokumentációt is a segítségével.
A Doxygen a legtöbb disztribúció fő szoftvertárolóiban szerepel, szóval telepíthetjük apt-get-tel:
sudo apt-get install doxygen
Doxyfile generálás:
doxygen -g
Ezután már szerkeszthetjük a Doxyfile-t, hogy testreszabjuk a dokumentációnkat:
gedit Doxyfile
A Bash szkriptek támogatásához a következő módosításokat tegyük meg (a megoldást egy amerikai fiatalember honlapján találtam meg):
FILE_PATTERNS = *.shINPUT_FILTER = "sed -e 's|##|//!|'"
FILTER_SOURCE_FILES = YES
Ezután dupla kettőskereszt (##) után írhatjuk a dokumentációt, azonban csak kivonatok (brief description) formájában tehetjük meg. Ebben az esetben az egy oldalra szánt dokumentációkat sorfolytonosan, összefüggően kell megírni; valamint elég sok Doxygen parancsot nem használhatunk.
Én a következő parancsokat szoktam használni (az összes parancs leírása itt található):
@author@file@version@mainpage@page@section@subsection@param@return@details\code - \endcode
Természetesen működik néhány parancs még, de ezeket teszteltem.
Nincsenek megjegyzések:
Megjegyzés küldése