Dokumentace kodu

Ondřej Janovský ondrej.janovsky na alarex.cz
Čtvrtek Červen 18 13:10:31 CEST 2015


Zkuste GITBOOK. Je to online služba, ale můžete si stáhnout řádkové 
nástroje na generování dokumentace (jsou opensource).
Dokumentace se píše pomocí jednoduchého značkovacího jazyka Markdown. 
http://gitbookio.gitbooks.io/markdown/content/

Dokumentace je primárně v HTML, ale lze ji zkonvertovat do EPUB nebo PDF.

Já jsem používal Publican, což je generátor postavený nad DocBook, ale 
bohužel poslední verze se mi nedaří bezchybně rozběhat na Ubuntu. Tak 
jsem našel GitBook.

Pokus o dokumentaci, která byla dříve v Publicanu je na 
http://ondrejjanovsky.gitbooks.io/m2mscript/content/

Oja


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 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 by www.HW.cz
> Hw-list na list.hw.cz
> http://list.hw.cz/mailman/listinfo/hw-list


-- 
*Ondřej Janovský
Alarex-Group s.r.o.
*
mobil: +420 723 616 751
em na il: ondrej.janovsky na alarex.cz

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


Další informace o konferenci Hw-list