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

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

ؙࢁ྄!IJNBSV $PPLQBE*OD

ॕ&$."4DSJQU BLB&4

&4࣌୅ͷ։ൃ؀ڥ ࢲݟ

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

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

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

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

&4%PD OQNJOTUBMMFTEPD

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

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

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

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

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

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

ΧόϨοδ ܧଓੑ

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

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

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

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

ςετͱͷΠϯςάϨʔτ 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’); }); }); ؔ࿈ੑ

ςετͱͷΠϯςάϨʔτ 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ͷΈͷରԠ ؔ࿈ੑ

ݕࡧ w Ϋϥε໊  ϝιου໊  ϓϩύςΟ໊  ϑΝΠϧ໊  ςετ໊ w ݕࡧΠϯσοΫε ݕࡧੑ

ͦͷଞ

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

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

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

վળ͕ඞཁͳͱ͜Ζ

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

·ͱΊ

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

એ఻

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

͓ΘΓ w FTEPDPSH w DPEFMVODIGN w JODIDJPSH w HJUIVCDPNKTEPDKTEPDJTTVFT

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

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

More Decks by Ryo Maruyama

Other Decks in Technology

Featured

Transcript