Dokumentace kodu
Jan Waclawek
konfera na efton.sk
Čtvrtek Červen 18 19:23:59 CEST 2015
... no a zle knizky su zase plne takychto bonmotov.
Ale mozete to chapat takto:
Dobre napisany program(*) nepotrebuje komentare - boli predsa spolu s nim
uz napisane.
wek
(*)neznasam slovo "kod" ako nahrada slova "program"
----- Original Message ---------------
Subject: Re: Dokumentace kodu
From: Michal Gregor <a2x1nptda8 at email.cz>
Date: Thu, 18 Jun 2015 18:52:46 +0200
To: HW-news <hw-list at list.hw.cz>
>No v jedne knizce se pise:
>"Dobre napsany kod nepotrebuje komentare."
>
>Michal Gregor
>
>Dne 18.6.2015 v 11:57 Karel M napsal(a):
>> 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.
>>
>> Dne 18. června 2015 10:58 Jan Waclawek <konfera at efton.sk
>> <mailto:konfera at efton.sk>> napsal(a):
>>
>> Pozrite http://www.efton.sk/misc/snake.zip (robi to toto:
>> https://www.youtube.com/watch?v=pCx6SKWVDkw)
>>
>> Vyznate sa v tom? Tak to berte ako kladny priklad. Ak nie, berte to ako
>> zaporny priklad.
>>
>> wek
>>
>>
>> PS. zrejme Vam doporucia doxygen - ja osobne to mam rovnako nerad ako
>> arduino ;-)
>>
>>
>>
>> ----- Original Message ---------------
>>
>> >Pěkný den, rád bych provedl dokumentaci programu psaného v C
>> určeného pro
>> >MCU AVR, tak aby to snadno mohl převzít jiný programátor, nebo i
>> já sám
>> >kdyµ bych se po čase k programu vrátil. Bohuµel s tím nemám µádné
>> >zku±enosti, chtěl bych Vás poprosit, zda nemáte nějaký naučný příklad.
>> >Díky
>> >Karel M.
>>
>> _______________________________________________
>> HW-list mailing list - sponsored by www.HW.cz <http://www.HW.cz>
>> Hw-list at list.hw.cz <mailto:Hw-list at list.hw.cz>
>> http://list.hw.cz/mailman/listinfo/hw-list
>>
>>
>>
>>
>> _______________________________________________
>> HW-list mailing list - sponsored by www.HW.cz
>> Hw-list at list.hw.cz
>> http://list.hw.cz/mailman/listinfo/hw-list
>>
>_______________________________________________
>HW-list mailing list - sponsored by www.HW.cz
>Hw-list at list.hw.cz
>http://list.hw.cz/mailman/listinfo/hw-list
Daląí informace o konferenci Hw-list