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

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

345968ba4b332a6dbd6fa70fa9fa777b?s=128

Ryo Maruyama

June 26, 2015
Tweet

Transcript

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

  2. ؙࢁ྄!IJNBSV $PPLQBE*OD

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

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

  5. &4࣌୅ͷ։ൃ؀ڥ ࢲݟ ίʔυ &4 #BCFM ςετ .PDIB QPXFSBTTFSU υΩϡϝϯτ +4%PD

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

  7. &4࣌୅ͷ։ൃ؀ڥ ࢲݟ ίʔυ &4 #BCFM ςετ .PDIB QPXFSBTTFSU υΩϡϝϯτ +4%PD

  8. &4࣌୅ͷ։ൃ؀ڥ ࢲݟ ίʔυ &4 #BCFM ςετ .PDIB QPXFSBTTFSU υΩϡϝϯτ &4%PD

  9. &4%PD OQNJOTUBMMFTEPD

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

  11. &4%PD

  12. &4%PD

  13. &4%PDͷΰʔϧ ιʔείʔυΛݟͳͯ͘΋
 ιϑτ΢ΣΞΛ࢖͏͜ͱ͕Ͱ͖Δ
 υΩϡϝϯτΛੜ੒͢Δ͜ͱ

  14. &4%PDͷΰʔϧ ιʔείʔυΛݟͳͯ͘΋
 ιϑτ΢ΣΞΛ࢖͏͜ͱ͕Ͱ͖Δ
 υΩϡϝϯτΛੜ੒͢Δ͜ͱ υΩϡϝϯτͷੑ࣭Λߟ͑ͯΈͨ

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

    ݕࡧੑ
  16. υΩϡϝϯτͷੑ࣭ w ܧଓੑˠΧόϨοδ w ࣮༻ੑˠৄࡉͳ৘ใ w ໢ཏੑˠ੩తղੳΈ͍ͨͳ΋ͷ  w ؔ࿈ੑˠςετͱͷΠϯςάϨʔτ

    w ݕࡧੑˠݕࡧ &4%PDͰͷ࣮ݱํ๏
  17. ΧόϨοδ w υΩϡϝϯτͷΧόϨοδ w શମͰԿॻ͔Ε͍ͯΔ͔ w ':*JODIDJPSH ܧଓੑ

  18. ΧόϨοδ ܧଓੑ

  19. ৄࡉͳ৘ใ ΫϥεҰཡ ϝιουҰཡ ϓϩύςΟҰཡ ܧঝؔ܎ ܧঝϝιου ΦʔόʔϥΠυϝιο υ Ҿ਺ ໭Γ஋

    σϑΥϧτҾ਺ δΣωϦΫε %FQSFDBUFE &YQFSJNFOUBM 50%0 όʔδϣϯ ֎෦Ϋϥε FUD ࣮༻ੑ
  20. ੩తղੳͷΑ͏ͳ΋ͷ w λά͕ແͯ͘΋υΩϡϝϯτΛੜ੒ w &4ͷσϑΥϧτҾ਺Λ࢖ͬͯҾ਺ͷܕΛਪଌ w SFUVSOจ͔Β໭Γ஋ͷܕΛਪଌ /** * this

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

    * this is useful function. */ function foo(p = 123) { return `p = ${p}`; } ໢ཏੑ
  22. ςετͱͷΠϯςάϨʔτ w ςετ΋ॏཁͳυΩϡϝϯτ w ΫϥεϝιουͷυΩϡϝϯτ㱻ର৅ͷςετ ؔ࿈ੑ

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

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

  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’); }); }); ؔ࿈ੑ
  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ͷΈͷରԠ ؔ࿈ੑ
  27. ݕࡧ w Ϋϥε໊
 ϝιου໊
 ϓϩύςΟ໊
 ϑΝΠϧ໊
 ςετ໊ w ݕࡧΠϯσοΫε ݕࡧੑ

  28. ͦͷଞ

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

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

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

    ओʹΫϥεؔ࿈
  32. վળ͕ඞཁͳͱ͜Ζ

  33. վળ͕ඞཁͳͱ͜Ζ w υΩϡϝϯτͷϏϧυ࣌ؒ w ߦ!.#1ඵ w ࣮੷͕গͳ͍ͷͰෆ۩߹͕·ͩ͋Δ w FTEPDJTTVFT w

    ϗεςΟϯά w SVCZEPDJOGPͱ͔HPEPDPSHΈ͍ͨͳͷཉ͍͠
  34. ·ͱΊ

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

  36. એ఻

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

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