Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Speaker Deck
PRO
Sign in
Sign up
for free
ESDoc - ES6時代のドキュメンテーションツール
Ryo Maruyama
June 26, 2015
Technology
6
1.7k
ESDoc - ES6時代のドキュメンテーションツール
Ryo Maruyama
June 26, 2015
Tweet
Share
More Decks by Ryo Maruyama
See All by Ryo Maruyama
h13i32maru
15
8.6k
h13i32maru
15
7.3k
h13i32maru
39
8.4k
Other Decks in Technology
See All in Technology
hikarut
1
110
kanaugust
PRO
0
120
noir_neo
0
130
terurou
0
250
sky_joker
0
180
yutamakotaro
1
230
recruitengineers
0
150
kilometer
0
170
ocise
0
210
bells17
1
730
jxck
2
260
gkzz
0
360
Featured
See All Featured
productmarketing
5
660
chriscoyier
684
180k
colly
65
3k
lauravandoore
11
1.3k
thoeni
4
550
tammielis
237
23k
orderedlist
PRO
329
35k
lara
16
2.6k
shlominoach
176
7.4k
hursman
106
9.2k
chrislema
231
16k
geeforr
332
29k
Transcript
&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
&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 ΫϥεϝιουͷυΩϡϝϯτ㱻ରͷςετ ؔ࿈ੑ
ςετͱͷΠϯςάϨʔτ 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