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)

Opis programu ( specyfikacja)[edytuj]

Specyfikacja programu opisuje jego cechy. Pozwala to na lepsze zrozumienie programu. Nie musimy wypełniać wszystkich cech, ale im więcej tym lepiej.

Specyfikacja programu:

  • język mówiony( polski, angielski, ...)- dotyczy komentarzy, opisów, dokumentacji, nazw
  • język programowania (pascal / delph, c, c++, c#,...)- dotyczy kodu źródłowego
  • kompilator
  • IDE
  • styl progrmowania ( Paradygmat programowania): proceduralne, obiektowe, ...
  • metoda programowania : visual (Rapid application development RAD),
  • Metodyki tworzenia oprogramowania : kaskadowy, ...
  • typ interfejsu użytkownika: CLI, GUI, WUI, ...
  • licencja : GPL/Mozilla/shareware/commercial ...
  • cel ( który procesor wykonuje kod): CPU, GPU
  • Liczba wątków / procesów
  • system operacyjny (OS) : DOS, windows ( 95,98, ME, 2000, XP), linux, MacOS, wieloplatformowy
  • platform sprzętowa ( CPU i architektura): i386, i586,
  • typ komputera type: PC, [2]
  • data ( utworzenie programu, poprawek)
  • żródło ( adres internetowy repozytorium, strony domowej programu)
  • autor

Przykład:

{
spoken language: english
programming language: Pascal ( Borland object Pascal )
compiler: VER 140
IDE: Borland Delphi 7.0 personal edition
programming style : objective
programming method : visual (RAD)
target: CPU
number of microprocessors : 1 ; threads : 1 
library: standard =  VCL
program type : GUI application
licence: GNU GPL ; see  http://www.gnu.org/copyleft/gpl.html
OS: win32 (windows 98 SE
hardware: PC
platform:i386
author: 
Walbrzych/Poland/EU/europe/earth/Solar System/Milky Way/Universe (:-)))
2009.09.25
}

Czytnik dokumentacji[edytuj]


Zobacz również[edytuj]

Źródła[edytuj]

  1. forum ubuntu: Jak uruchomić Doxygena?
  2. Typy komputerów w wikipedii
  3. zeal strona domowa