Programowanie w systemie UNIX/dok

Z Wikibooks, biblioteki wolnych podręczników.
Przejdź do nawigacji Przejdź do wyszukiwania

"Program jest tak dobry jak jego dokumentacja"

Cel[edytuj]

  • wyjaśnienie działania programu. Różnią się w zależności czy jest to program o celach edukacyjnych czy komercyjny.

Rodzaje[edytuj]

  • ręczna
    • komentarze w kodzie źródłowym
    • pliki tekstowe
      • readme
  • automatyczna
    • doxygen

Doxygen[edytuj]

Sprawdzamy instalację: [1]

 file $(which doxygen)
 ls -l $(which doxygen)

Czytnik dokumentacji[edytuj]

Źródła[edytuj]

  1. forum ubuntu: Jak uruchomić Doxygena?
  2. zeal strona domowa