$30 off During Our Annual Pro Sale. View Details »

ESDoc - ES6時代のドキュメンテーションツール

ESDoc - ES6時代のドキュメンテーションツール

Ryo Maruyama

June 26, 2015
Tweet

More Decks by Ryo Maruyama

Other Decks in Technology

Transcript

  1. &4%PD
    &4࣌୅ͷυΩϡϝϯςʔγϣϯπʔϧ

    View Slide

  2. ؙࢁ྄!IJNBSV
    $PPLQBE*OD

    View Slide

  3. ॕ&$."4DSJQU
    BLB&4

    View Slide

  4. &4࣌୅ͷ։ൃ؀ڥ ࢲݟ

    View Slide

  5. &4࣌୅ͷ։ൃ؀ڥ ࢲݟ

    ίʔυ &4#BCFM
    ςετ .PDIBQPXFSBTTFSU
    υΩϡϝϯτ +4%PD

    View Slide

  6. +4%PDʹର͢Δෆຬ
    &4ʹະରԠ W
    JTTVF

    ग़ྗ͞ΕΔυΩϡϝϯτ͸΋ͬͱগ͠޻෉Ͱ͖Δ
    &4࣌୅ʹ͸ෆཁͳλά͕ଟ͍
    ίʔυϕʔε͕&4
    ಺෦Ͱ/PEFKTͱ3IJOP͕ࠞࡏ͍ͯ͠Δ

    View Slide

  7. &4࣌୅ͷ։ൃ؀ڥ ࢲݟ

    ίʔυ &4#BCFM
    ςετ .PDIBQPXFSBTTFSU
    υΩϡϝϯτ +4%PD

    View Slide

  8. &4࣌୅ͷ։ൃ؀ڥ ࢲݟ

    ίʔυ &4#BCFM
    ςετ .PDIBQPXFSBTTFSU
    υΩϡϝϯτ
    &4%PD

    View Slide

  9. &4%PD
    OQNJOTUBMMFTEPD

    View Slide

  10. &4%PD
    w &4ʹରԠ
    w ׬શରԠʹ͸·ͩͪΐͬͱ଍Γͳ͍
    w 3FBDU+49ʹ΋ରԠ

    View Slide

  11. &4%PD

    View Slide

  12. &4%PD

    View Slide

  13. &4%PDͷΰʔϧ
    ιʔείʔυΛݟͳͯ͘΋

    ιϑτ΢ΣΞΛ࢖͏͜ͱ͕Ͱ͖Δ

    υΩϡϝϯτΛੜ੒͢Δ͜ͱ

    View Slide

  14. &4%PDͷΰʔϧ
    ιʔείʔυΛݟͳͯ͘΋

    ιϑτ΢ΣΞΛ࢖͏͜ͱ͕Ͱ͖Δ

    υΩϡϝϯτΛੜ੒͢Δ͜ͱ
    υΩϡϝϯτͷੑ࣭Λߟ͑ͯΈͨ

    View Slide

  15. υΩϡϝϯτͷੑ࣭
    w ܧଓੑ
    w ࣮༻ੑ
    w ໢ཏੑ
    w ؔ࿈ੑ
    w ݕࡧੑ

    View Slide

  16. υΩϡϝϯτͷੑ࣭
    w ܧଓੑˠΧόϨοδ
    w ࣮༻ੑˠৄࡉͳ৘ใ
    w ໢ཏੑˠ੩తղੳΈ͍ͨͳ΋ͷ

    w ؔ࿈ੑˠςετͱͷΠϯςάϨʔτ
    w ݕࡧੑˠݕࡧ
    &4%PDͰͷ࣮ݱํ๏

    View Slide

  17. ΧόϨοδ
    w υΩϡϝϯτͷΧόϨοδ
    w શମͰԿॻ͔Ε͍ͯΔ͔
    w ':*JODIDJPSH
    ܧଓੑ

    View Slide

  18. ΧόϨοδ
    ܧଓੑ

    View Slide

  19. ৄࡉͳ৘ใ
    ΫϥεҰཡ ϝιουҰཡ ϓϩύςΟҰཡ
    ܧঝؔ܎ ܧঝϝιου
    ΦʔόʔϥΠυϝιο
    υ
    Ҿ਺ ໭Γ஋ σϑΥϧτҾ਺
    δΣωϦΫε
    %FQSFDBUFE
    &YQFSJNFOUBM
    50%0
    όʔδϣϯ ֎෦Ϋϥε FUD
    ࣮༻ੑ

    View Slide

  20. ੩తղੳͷΑ͏ͳ΋ͷ
    w λά͕ແͯ͘΋υΩϡϝϯτΛੜ੒
    w &4ͷσϑΥϧτҾ਺Λ࢖ͬͯҾ਺ͷܕΛਪଌ
    w SFUVSOจ͔Β໭Γ஋ͷܕΛਪଌ
    /**
    * this is useful function.
    */
    function foo(p = 123) {
    return `p = ${p}`;
    }
    ໢ཏੑ

    View Slide

  21. ੩తղੳͷΑ͏ͳ΋ͷ
    w λά͕ແͯ͘΋υΩϡϝϯτΛੜ੒
    w &4ͷσϑΥϧτҾ਺Λ࢖ͬͯҾ਺ͷܕΛਪଌ
    w SFUVSOจ͔Β໭Γ஋ͷܕΛਪଌ
    ·࣮ͩݧతͳ࣮૷ͳͷͰੑ
    ೳ͸͓࡯͍ͩ͘͠͞
    /**
    * this is useful function.
    */
    function foo(p = 123) {
    return `p = ${p}`;
    }
    ໢ཏੑ

    View Slide

  22. ςετͱͷΠϯςάϨʔτ
    w ςετ΋ॏཁͳυΩϡϝϯτ
    w ΫϥεϝιουͷυΩϡϝϯτ㱻ର৅ͷςετ
    ؔ࿈ੑ

    View Slide

  23. ςετͱͷΠϯςάϨʔτ
    w ςετ΋ॏཁͳυΩϡϝϯτ
    w ΫϥεϝιουͷυΩϡϝϯτ㱻ର৅ͷςετ
    ؔ࿈ੑ

    View Slide

  24. ςετͱͷΠϯςάϨʔτ
    w ςετ΋ॏཁͳυΩϡϝϯτ
    w ΫϥεϝιουͷυΩϡϝϯτ㱻ର৅ͷςετ
    ؔ࿈ੑ

    View Slide

  25. ςετͱͷΠϯςάϨʔτ
    w ઃఆϑΝΠϧͰςετίʔυͷσΟϨΫτϦΛࢦఆ
    w ςετίʔυʹAA!UFTU\'PPCBS^AAΛهड़
    /** @test {Foo} */
    describe(‘Foo is useful class’, ()=>{
    /** @test {Foo#bar} */
    it(‘is useful method’, ()=>{
    let foo = new Foo();
    assert(typeof foo.bar, ‘function’);
    });
    });
    ؔ࿈ੑ

    View Slide

  26. ςετͱͷΠϯςάϨʔτ
    w ઃఆϑΝΠϧͰςετίʔυͷσΟϨΫτϦΛࢦఆ
    w ςετίʔυʹAA!UFTU\'PPCBS^AAΛهड़
    /** @test {Foo} */
    describe(‘Foo is useful class’, ()=>{
    /** @test {Foo#bar} */
    it(‘is useful method’, ()=>{
    let foo = new Foo();
    assert(typeof foo.bar, ‘function’);
    });
    });
    ݱࡏ͸.PDIBͷΈͷରԠ
    ؔ࿈ੑ

    View Slide

  27. ݕࡧ
    w Ϋϥε໊

    ϝιου໊

    ϓϩύςΟ໊

    ϑΝΠϧ໊

    ςετ໊
    w ݕࡧΠϯσοΫε
    ݕࡧੑ

    View Slide

  28. ͦͷଞ

    View Slide

  29. Πϯϙʔτύε
    w υΩϡϝϯτͰJNQPSUͷํ๏ΛݟΕΔ

    View Slide

  30. ΧελϚΠζ
    w ೚ҙͷ+4ͱ$44Λ૊ΈࠐΊΔ
    w ϑοΫϙΠϯτͷఏڙΛݕ౼த
    w λάͷύʔεޙ)5.-ͷੜ੒ޙ

    View Slide

  31. ෆཁͳλάΛ࡟আ
    w +4%PDݸ
    w &4%PDݸ
    w Α͘࢖͏ͷ͸ݸఔ౓
    w &4ʹͳͬͯෆཁʹͳͬͨ΋ͷ͕ଟ͍
    w ओʹΫϥεؔ࿈

    View Slide

  32. վળ͕ඞཁͳͱ͜Ζ

    View Slide

  33. վળ͕ඞཁͳͱ͜Ζ
    w υΩϡϝϯτͷϏϧυ࣌ؒ
    w ߦ!.#1ඵ
    w ࣮੷͕গͳ͍ͷͰෆ۩߹͕·ͩ͋Δ
    w FTEPDJTTVFT
    w ϗεςΟϯά
    w SVCZEPDJOGPͱ͔HPEPDPSHΈ͍ͨͳͷཉ͍͠

    View Slide

  34. ·ͱΊ

    View Slide

  35. ·ͱΊ
    w &4ͷυΩϡϝϯτͳΒ&4%PDࢼͯ͠Έͯʂ
    w υΩϡϝϯτॻ͘ͱॻ͖खʹ΋͍͍͜ͱ͕͋Δʂ
    w *TTVF134UBS͓଴͍ͪͯ͠·͢ʂ
    5IBOLZPVGPSDPOUSJCVUJPO

    View Slide

  36. એ఻

    View Slide

  37. $PEF-VODIGN
    (P '1(" 1)1 FUD

    View Slide

  38. ͓ΘΓ
    w FTEPDPSH
    w DPEFMVODIGN
    w JODIDJPSH
    w HJUIVCDPNKTEPDKTEPDJTTVFT

    View Slide