Docコメントで始める簡単ガードレール

https://typescript-jpc.connpass.com/event/382128/

Transcript

1. %PDίϝϯτͰ࢝ΊΔ
   ؆୯ΨʔυϨʔϧ
   ,FJTVLF
   *LFEB 
   54,BJHJ
   .BTIVQ
   ,BOTBJ !JLF@LFJDIBO
2. 自己紹介 02/21 ,FJTVLF
   *LFEB ɾ౦ژͱؔ੢ʢେࡕژ౎ʣͷڌ఺ੜ׆த
   ɾ54,BJHJ
    
   
   ϑϩϯτΤϯυΧϯϑΝϨϯεؔ੢
    
   ɹ
   3FBDU5PLZPϑΣε
   
   ͷελοϑ
   ɾษڧձେ޷͖Ϛϯ
   ษڧձதͷπΠʔτ͕͏Δ͍͞
   ɾ࠷ۙɺ໑ͱै໑͕࢈·ΕͨͷͰྑ͍॑෕ˍै॑෕ʹͳΓ͍ͨ !JLF@LFJDIBO
3. 03/21 օ͞Μ͸%PDίϝϯτॻ͖·͔͢ʁ Docコメントについて !JLF@LFJDIBO
4. 04/21 ɾ
   ͱ!Ͱॻ͘ߏ଄తͳίϝϯτه๏
   ɾ௨ৗͷίϝϯτͷҧ͍
   ɹ
   *%&ΛؚΉଟ͘ͷπʔϧͷػೳΛิॿ
   ɹ
   πʔϧΛར༻ͯ͠υΩϡϝϯτΛੜ੒Մೳ
   ɹ
   ɾجຊతʹϝδϟʔͳݴޠʹ͸ఆΊΒΕͨඪ४ه๏͕ଘࡏ
   ɹ
   +BWBEPD
   %PDTUSJOH
   +4%PD
   54%PD
   (P%PD
   %PYZHFO
    %PDίϝϯτͱ͸ʁ Docコメントについて !JLF@LFJDIBO
5. 05/21 ɾ+BWBEPD͕ىݯ
   ɹ
   !QBSBNT
   ΍
   !SFUVSOT
   ͷΑ͏ʹ!Ͱλάه๏
   ɹ
   *%&ͳͲ͕+BWBEPDίϝϯτΛαϙʔτ࢝͠ΊΔ
   ɹ
   ίϝϯτ͔ΒυΩϡϝϯτੜ੒Մೳ
   ɹ
   ίϝϯτͷॻ͖ํͷඪ४ʹ
   ɾଞݴޠ΁ͷීٴ
   ɹ
   +BWBEPDͷॻ͖ํ͕ଞݴޠͰ΋࢖༻͞ΕΔ
   ɹ
   ݴޠͷҧ͍Λٵऩ͢ΔͨΊʹɺ֤ݴޠ͝ͱͷඪ४͕஀ੜʢ+4%PDͳͲʣ
   %PDͷྺ࢙ Docコメントについて !JLF@LFJDIBO
6. 06/21 ɾ։ൃεϐʔυΛ༏ઌͨ͠ࡍʹɺ༏ઌ౓͕௿͘ͳΔɻ
   ɾίϝϯτʹ΋ϝϯςφϯείετ͕͋Γɺݹ͍%PDίϝϯτ͕ٯʹϊΠζ
   ɹʹͳΔɻ
   
   ɾ*%&ΛؚΉଟ͘ͷπʔϧͷิ׬΍ਪ࿦͕ڧྗʹͳΓɺ%PDίϝϯτͰิ
   ɹ଍͢Δҙຯ͕ബ͘ͳΔɻ %PDίϝϯτ͸ॻ͘ඞཁ͕͋Δͷ͔ʁʢʣ
   Docコメントについて !JLF@LFJDIBO
7. 07/21 ɾςετ͕υΩϡϝϯτ୅ΘΓʹͳͬͨɻ
   ɾΫϦʔϯͳίʔυͰ͋Ε͹ɺίʔυͦͷ΋ͷ͕υΩϡϝϯτʹͳΓ͏Δɻ
   ɾͦ΋ͦ΋ա৒ʹίϝϯτΛॻ͘΂͖Ͱ͸ͳ͍ɻίʔυͰ೺ѲͰ͖Δ͜ͱΛ
   ɹίϝϯτͰॻ͘΂͖Ͱ͸ͳ͍ͱ͍͏ߟ͕͑ීٴɻ
   
   ɾ5ZQF4DSJQUʹؔͯ͠ݴ͑͹ɺܕ৘ใΛίϝϯτͰิ͏ඞཁ͕ͳ͘ͳͬͨɻ %PDίϝϯτ͸ॻ͘ඞཁ͕͋Δͷ͔ʁʢʣ
   Docコメントについて !JLF@LFJDIBO
8. 08/21 Docコメントを書く理由 !JLF@LFJDIBO ੜ੒"*͕౰ͨΓલͷ࣌୅ʹ
   %PDίϝϯτॻ͘ඞཁ͕͋Δͷ͔ʁ
9. 09/21 Docコメントを書く理由 "*͸ʮ࣮૷ʯ͸෼͔Δ͕ʮҙਤʯ͸෼͔Βͳ͍
   const sendInvitation = async (inviterId: string, email: string): Promise<void> => { const inviter = await getUser(inviterId); if (inviter.invitationCount >= 5) return; await sendEmail(email, '招待', inviteUrl(inviterId)); await incrementInvitationCount(inviterId); }; !JLF@LFJDIBO
10. 11/21 Docコメントを書く理由 ͦΕͧΕͷπʔϧͰ෼͔Δ͜ͱ
    !JLF@LFJDIBO
11. 10/21 Docコメントを書く理由 %PDίϝϯτͰʮҙਤʯ͕෼͔Δ
    /** * 招待メールを送信する。 * 招待上限は不正利用防止のため5件に制限（仕様#123参照）。 * 上限超過時はエラーにしない仕様。呼び出し元でチェック不要。 * @param email 未登録アドレスであることは呼び出し元で検証すること。 */ const sendInvitation = async (inviterId: string, email: string): Promise<void> => { const inviter = await getUser(inviterId); if (inviter.invitationCount >= 5) return; await sendEmail(email, '招待', inviteUrl(inviterId)); await incrementInvitationCount(inviterId); }; !JLF@LFJDIBO
12. 12/21 Docコメントを書く理由 ී௨ͷίϝϯτͰ͸ͩΊͳͷ͔ʁ ɾνʔϜ಺Ͱॻ͖ํΛڞ௨ԽͰ͖Δɻ
    ɹ
    ී௨ͷίϝϯτͩͱॻ͖ํ͕όϥόϥʹͳΓ΍͍͢ɻ
    ɹ
    "*ʹίϝϯτΛॻ͍ͯ΋Β͏৔߹Ͱ΋จମ͕ἧ͍΍͍͢ɻ
    ɾ*%&ΛؚΉଟ͘ͷπʔϧͷԸܙ΋ड͚ΒΕΔɻ
    
    ɾ"*͕ߏ଄Խ͞Εͨ৘ใͱͯ͠ಡΈऔΓ΍͍͢ɻ !JLF@LFJDIBO
13. 13/21 Docコメントを書く理由 %PDίϝϯτ͸ίʔυͷྡʹ͋Δϓϩϯϓτ ɾ໾ׂͷ෼཭
    
    ɹ
    $-"6%&NEͳͲͷϓϩϯϓτϑΝΠϧ͸ந৅తͳϧʔϧΛॻ͘৔ॴͰ
    ɹ
    
    ͋ΓɺݸʑͷίʔυͷҙਤΛॻ͘ʹ͸ద͍ͯ͠ͳ͍ɻ
    
    ɾίʔυͱͷڑ཭
    ɹ
    ϓϩϯϓτϑΝΠϧ͸"*͕ࢀরͷͨΊʹผ్ϑΝΠϧಡΈࠐΈ͕ඞཁɻ
    ɹ
    %PDίϝϯτ͸ίʔυͱಉ͡ϑΝΠϧʹ͋ΔͨΊɺ"*͕ίʔυΛಡΉࡍ
    ɹ
    
    ʹࣗવʹҰॹʹಡΈऔΒΕΔɻ !JLF@LFJDIBO
14. 14/21 Docコメントを書く理由 ಋೖίετθϩ ɾ؀ڥߏங΋ઃఆϑΝΠϧͷมߋ΋ෆཁ
    ɾΤϥʔ͕ग़ͳ͍ͨΊطଘͷ։ൃϑϩʔΛյ͞ͳ͍
    ɾطଘͷίʔυϕʔεʹޙ͔Β௥ՃՄೳ
    ɾؔ਺͔Β։࢝Մೳ !JLF@LFJDIBO
15. 運用方法 15/21 %PDίϝϯτॻ͘ͷେมͱ͍͏࿩Λ
    ๨Ε͍ͯͳ͍ʁ !JLF@LFJDIBO
16. 運用方法 16/21 %PDίϝϯτ΋"*ʹॻ͔ͤΑ͏ʂ !JLF@LFJDIBO
17. 運用方法 17/21 %PDίϝϯτΛॻ͘ίετ΋"*ʹ೚ͤΔ !JLF@LFJDIBO
18. Docコメントは書くべき？ 18/21 ͜͜·Ͱͷ࿩Λ౿·͑ͯɺ
    %PDίϝϯτ͸ॻ͘΂͖ͳͷ͔ʁ !JLF@LFJDIBO
19. Docコメントは書くべき？ 19/21 %PDίϝϯτ͸ॻ͘΂͖͔ʁ ɾ"*ʹରͯ͠Ͳ͜·ͰΨʔυϨʔϧΛ੔උ͠ɺίϯτϩʔϧ͍͔ͨ͠
    
    ɾϦϯλʔɾςετɾܕఆ͕ٛे෼ʹ੔උ͞Ε͍ͯΔͳΒԸܙ͸গͳ͍
    ɹ
    ٯʹͦΕΒͷ੔උ͕ෆे෼ͳ৔߹͸Ըܙ͋Γ
    ɹ
    ಋೖίετθϩͰɺΤϥʔ΋ग़ͳ͍ͨΊ։ൃͷअຐʹͳΒͳ͍
    ɾ"*࢖༻લఏͰνʔϜશһͰ%PDίϝϯτΛϝϯςφϯεͰ͖Δ͔ʁ !JLF@LFJDIBO
20. まとめ 20/21 ·ͱΊʢʣ ɾܕɾϦϯλʔɾςετ΋"*΁ͷϓϩϯϓτʹͳΔ͕ɺʮҙਤʯ͸%PDίϝ
    ɹϯτͷํ͕఻ΘΓ΍͍͢
    ɾ%PDίϝϯτ͸ίʔυͷྡʹ͋Δہॴతͳϓϩϯϓτͱͯ͠ͷػೳ
    ɾ։ൃϑϩʔΛյ͞ͳ͍ಋೖίετθϩͷΨʔυϨʔϧ !JLF@LFJDIBO
21. まとめ 21/21 ·ͱΊʢʣ ɾ"*ʹ%PDίϝϯτΛॻ͔ͤΔ͜ͱͰɺ௿ίετͳҙਤͷ͢Γ߹Θͤͱ1MBO
    ɹϞʔυతͳӡ༻͕Մೳ
    ɾ%PDίϝϯτ͕༗ޮ͔͸νʔϜ΍ϓϩδΣΫτ࣍ୈɻ"*΁ͷΨʔυϨʔϧ
    ɹΛͲ͜·Ͱ੔උ͍͔ͨ͠Ͱ൑அ
    ɾ·ͣ͸ʮҙਤ͕఻ΘΓʹ͍͘ʯͱײͨؔ͡਺΁ͷ%PDίϝϯτ͔Β !JLF@LFJDIBO