<div dir="ltr"><div><div>Podle mne tato veta hodne vypovida o tom, jake programy jeji autor pise. Pokud pise program, ktery otevre soubor A, cisla v nem oddelena strednikem zobrazi do tabulky a pak je zase ulozi do podobneho souboru, tak si urcite dokaze vystacit s vhodne a vystizne pojmenovanymi promenymi a funkcemi. Ostatne takovych ukolu je spousta. Znam nekolik firem delajicich GUI jejichz programatori tvrdi, ze pokud se pise komentar, tak jsou spatne zvolene nazvy promenych.<br><br></div>Pokud ale program ma resit algoritmicky slozitejsi ulohu, popripade pokud ji ma resit hodne efektivne, tak se proste bez komentaru neobejdete. Uz jsem zazil i situaci, kdy nam trvalo skoro tyden, nez jsme dokazali, ze funkce dela to, co delat ma. A to proto, ze z duvodu optimalizace jeji autor provedl s vypocitavanym vzorcem nekolik uprav, ktere samozrejme nikde nezdokumentoval. Takze ve vysledku jsme meli jeden vzorecek, ktery rikal, co se ma pocitat, pak vzorecek co se pocital a pak dukaz, ze tyto vzorecky jsou ekvivaletni. A tohle uz bez dokumentace neokecate.<br><br></div>Honza<br><div><div><div><div><div><div class="gmail_extra"><br><div class="gmail_quote">Dne 18. června 2015 18:52 Michal Gregor <span dir="ltr"><<a href="mailto:a2x1nptda8@email.cz" target="_blank">a2x1nptda8@email.cz</a>></span> napsal(a):<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">No v jedne knizce se pise:<br>
"Dobre napsany kod nepotrebuje komentare."<br>
<br>
Michal Gregor<span class=""><br>
<br>
Dne 18.6.2015 v 11:57 Karel M napsal(a):<br>
</span><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Ano, vyznal bych se v tom, ale měl jsem na mysli něco jako souhrnný<span class=""><br>
dokument, obsahující např. jaké funkce mám k dispozici, jaké procesy se<br>
dějí v přerušení od timerů, prostě celkový náhled na složitý projekt<br>
násobně větší než ten snake game. Doxygen mi přijde jako zanášející<br>
bordel do kodu a dělá jej tak nepřehledným. Bloková schémata zas příliš<br>
jednoduchá nepopisující souvislosti. Nejde o to popsat každý řádek<br>
funkce, spíš něco co když přečtu tak získám obecný přehled co se tam děje.<br>
K.<br>
<br>
Dne 18. června 2015 10:58 Jan Waclawek <<a href="mailto:konfera@efton.sk" target="_blank">konfera@efton.sk</a><br></span>
<mailto:<a href="mailto:konfera@efton.sk" target="_blank">konfera@efton.sk</a>>> napsal(a):<span class=""><br>
<br>
Pozrite <a href="http://www.efton.sk/misc/snake.zip" rel="noreferrer" target="_blank">http://www.efton.sk/misc/snake.zip</a> (robi to toto:<br>
<a href="https://www.youtube.com/watch?v=pCx6SKWVDkw" rel="noreferrer" target="_blank">https://www.youtube.com/watch?v=pCx6SKWVDkw</a>)<br>
<br>
Vyznate sa v tom? Tak to berte ako kladny priklad. Ak nie, berte to ako<br>
zaporny priklad.<br>
<br>
wek<br>
<br>
<br>
PS. zrejme Vam doporucia doxygen - ja osobne to mam rovnako nerad ako<br>
arduino ;-)<br>
<br>
<br>
<br>
----- Original Message ---------------<br>
<br>
>Pěkný den, rád bych provedl dokumentaci programu psaného v C<br>
určeného pro<br>
>MCU AVR, tak aby to snadno mohl převzít jiný programátor, nebo i<br>
já sám<br>
>když bych se po čase k programu vrátil. Bohužel s tím nemám žádné<br>
>zkušenosti, chtěl bych Vás poprosit, zda nemáte nějaký naučný příklad.<br>
>Díky<br>
>Karel M.<br>
<br>
_______________________________________________<br></span>
HW-list mailing list - sponsored by <a href="http://www.HW.cz" rel="noreferrer" target="_blank">www.HW.cz</a> <<a href="http://www.HW.cz" rel="noreferrer" target="_blank">http://www.HW.cz</a>><br>
<a href="mailto:Hw-list@list.hw.cz" target="_blank">Hw-list@list.hw.cz</a> <mailto:<a href="mailto:Hw-list@list.hw.cz" target="_blank">Hw-list@list.hw.cz</a>><br>
<a href="http://list.hw.cz/mailman/listinfo/hw-list" rel="noreferrer" target="_blank">http://list.hw.cz/mailman/listinfo/hw-list</a><span class=""><br>
<br>
<br>
<br>
<br>
_______________________________________________<br>
HW-list mailing list - sponsored by <a href="http://www.HW.cz" rel="noreferrer" target="_blank">www.HW.cz</a><br>
<a href="mailto:Hw-list@list.hw.cz" target="_blank">Hw-list@list.hw.cz</a><br>
<a href="http://list.hw.cz/mailman/listinfo/hw-list" rel="noreferrer" target="_blank">http://list.hw.cz/mailman/listinfo/hw-list</a><br>
<br>
</span></blockquote><div class="HOEnZb"><div class="h5">
_______________________________________________<br>
HW-list mailing list - sponsored by <a href="http://www.HW.cz" rel="noreferrer" target="_blank">www.HW.cz</a><br>
<a href="mailto:Hw-list@list.hw.cz" target="_blank">Hw-list@list.hw.cz</a><br>
<a href="http://list.hw.cz/mailman/listinfo/hw-list" rel="noreferrer" target="_blank">http://list.hw.cz/mailman/listinfo/hw-list</a><br>
</div></div></blockquote></div><br></div></div></div></div></div></div></div>