Dokumentace kodu

[Jaroslav Rybárik]

Tak nejak to vidim aj ja s doxygen. Nepouzivam ho, ale ako sa v nom 
zapisuju "navody" a popisy k funkciam sa mi paci a pouzivam to tak, len 
pre seba. Vedlajsi efekt je, ze keby na to niekto ten doxygen pustil, 
tak by z toho asi ta dokumentacia vznikla :) ale ako niektore IDE pchaju 
hviezdicky a podobne veci do komentarov vadi aj mne. C++ komentare zas 
pouzivam na zapoznamkovanie kusku kodu, ked nieco odladujem a niektore 
editory ho daju inou farbou ako bezny blok poznamky a to mi tiez 
vyhovuje. Vsetko je hned jasnejsie, co je poznamka a co "vypnuty kod" :)

Jaro


On 06/18/2015 01:48 PM, Milan B. wrote:
> On 6/18/2015 11:57 AM, Karel M wrote:
>
>> Doxygen mi přijde jako zanášející bordel do kodu a dělá jej tak 
>> nepřehledným.
>
> Ale no...
>
> Bordel si tam zanasate sam, pripadne nejake to IDE ci kodovy generator 
> ktore ich tam sam strka. Doxygen komentare si predsa pisete sam a 
> formatujete si ich tak, ako chcete;  doxygen je pomerne tolerantny. 
> Tych par klucovych slov zase az tak vela bordelu nenarobi. Vo vysledku 
> sa doxygenizovany kod sa nemusi prilis lisit od normalne 
> okomentovaneho kodu. To ze nejake IDE generuje skarede doxygen 
> komentare neznamena, ze take musia byt.
>
> Osobne tiez nemam rad ten vseobecne presadzovany a prezentovany 
> rozvleceny format C-ckovych komentarov. Uprednostnujem C++ komentare, 
> vysledok je kompaktnejsi a prehladnejsi. Ale to je otazka osobnych 
> preferencii.
>
> Ale doxygen je kazdopadne dokumentacia kodu, nie dokumentacia projektu.
>
> Doxygen moze mat jeden pekny vedlajsi efekt: ked clovek vidi 
> vygenerovany vystup, tak zacne pisat komentare tak, aby davali zmysel.
>
> -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 na efton.sk 
>> <mailto:konfera na 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 na list.hw.cz <mailto:Hw-list na list.hw.cz>
>>     http://list.hw.cz/mailman/listinfo/hw-list
>>
>>
>>
>>
>> _______________________________________________
>> HW-list mailing list  -  sponsored bywww.HW.cz
>> Hw-list na list.hw.cz
>> http://list.hw.cz/mailman/listinfo/hw-list
>
>
>
> _______________________________________________
> HW-list mailing list  -  sponsored by www.HW.cz
> Hw-list na list.hw.cz
> http://list.hw.cz/mailman/listinfo/hw-list

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