Re: Dokumentace kodu

[Zdenek]

Záleží, co od toho očekáváte a k čemu to má sloužit.
V SW firmě máme několik druhů dokumentace:
- Systémová analýza - vzniká jako zadání pro program. Popisuje procesy, funkce, datovou strukturu a třeba i návrhy obrazovek.
- Systémový desing - podobné v podrobnějším podání. Reflektuje použitou technologii.
- Komenáře v kódu
- Uživatelská dokumentace - v podstatě návod pro uživatele
 
Z.
 
______________________________________________________________
> Od: Karel M <a8dtljb na gmail.com>
> Komu: "HW-news" <hw-list na list.hw.cz>
> Datum: 18.06.2015 11:57
> Předmět: Re: Dokumentace kodu
>
Ano, vyznal bych se v tom, ale měl jsem na mysli něco jako souhrnný dokument, obsahující např. jaké funkce mám k dispozici, jaké procesy se dějí v přerušení od timerů, prostě celkový náhled na složitý projekt násobně větší než ten snake game. Doxygen mi přijde jako zanášející bordel do kodu a dělá jej tak nepřehledným. Bloková schémata zas příliš jednoduchá nepopisující souvislosti. Nejde o to popsat každý řádek funkce, spíš něco co když přečtu tak získám obecný přehled co se tam děje.K.

------------- další část ---------------
HTML příloha byla odstraněna...
URL: <http://list.hw.cz/pipermail/hw-list/attachments/20150618/ac59d1b9/attachment.html>