RSS Feed LinkedIn Google Plus

Címke: docco

  1. JavaScript Documentation Sucks

    2012. február 8. szerda

    I want to use your JavaScript library. I really do.

    Unfortunately, a lot of you are bad at documenting it, so I can’t figure out how to use it before I give up and find something easier to learn.

    Írja Harry Brundage a sokat sejtető cikkjében. Sajnos JavaScript-re a mai napig nincsen folyamatosan karbantartott dokumentáció készítő eszköz. A docco nem az, hiszen alapvetően a kód megértését segíti, nem a használatát. A JSDoc legutóbbi kiadása 2010 júniusában volt. De még ha aktualizálva is lenne, a felhasználáshoz szükséges példák nagyon meg tudják növelni a dokumentációs blokkokat, ami viszont a fejlesztést nehezíti. Talán Harry fogja elhozni a megoldást?

    I also have my own storm a’brewin. Come back and check here in a couple weeks.


  2. JavaScript dokumentáció

    2011. július 5. kedd

    A Reddit-en valaki jól dokumentált JavaScript kódot keresett. Az underscore.js által is használt docco szerintem nagyon szép kimenetet ad, de API dokumentációnak nem használható jól. A JSDoc Toolkit-et nem fejlesztik. Mi a Natural Docs-t használjuk. Ez a forrással nem foglalkozik, csak kiszedi a dokumentációs megjegyzéseket. Nem valami intelligens, de sokkal jobb, mintha egy program megpróbálna okosnak látszani…