Programowanie w systemie UNIX/dok

"Program jest tak dobry jak jego dokumentacja"

Cel

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

Rodzaje

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

Doxygen

Sprawdzamy instalację:

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

Czytnik dokumentacji

• zeal
• https://devdocs.io/c/
• Lepton