|
Doxygen
jest narzędziem wspierającym dokumentowanie kodu źródłowego przy tworzeniu oprogramowania.
Idea:
- ujednolicenie sposobu komentowania kodu
- automatyczne generowanie dokumentacji
Obsługiwane języki programowania:
- w pełni:
- C
- C++
- Objective-C
- Java
- Python
- IDL (Corba and Microsoft flavors)
- w ograniczonym zakresie:
Formaty wyjściowe dokumentacji:
- HTML
- LaTeX
- RTF
- PDF
- PostScript
- Unix Manual
Aby uzyskać dokumentację należy po pierwsze odpowiednio skomentować kod, a po drugie uruchomić Doxygen'a z odpowiednim plikiem konfiguracyjnym.
Dokumentacja jest generowana bezpośrednio z kodu źródłowego, co zwalnia programistę z konieczności oddzielnego jej przechowywania i wersjonowania.
Można skonfigurować Doxygen'a w taki sposób, aby bez odpowiednich (rozumianych przez Doxygen'a) komentarzy wygenerował dokumentację tylko na
podstawie kodu. Pozwala to szybko zorientować się w budowie dużych projektów programistycznych.
|
|
|