RDoc meets YARD

https://rubyassociation.doorkeeper.jp/events/184561

Transcript

1. RDoc meets YARD - RDoc΁ͷ YARDղੳػೳͷ૊ΈࠐΈ Ruby Association Activity Report OKURA Masafumi, 2025-08-28
2. pritty_print(self) • ໊લɿେ૔խ࢙ʢ͓͓͘Β·͞;Έʣ • ॴଐɿϑϦʔϥϯε • ׆ಈɿKaigi on RailsʢൃىਓɺνʔϑΦʔΨφΠβʔʣɺOSS׆ಈ ʢAlbaͳͲʣɺొஃʢRubyConfTw 2025, Rails World 2025, Friendly.rbͳͲʣ • ޷͖ͳϝιουɿ`BasicObject#instance_eval`
3. RDoc meets YARD
4. RDoc meets YARD
5. RDocͱ͸ • Rubyʹඪ४ఴ෇͞Ε͍ͯΔʢผ్ͷΠϯετʔϧ͕ෆཁͳʣυΩϡϝ ϯςʔγϣϯπʔϧ • HTMLυΩϡϝϯτΛੜ੒͢Δ`rdoc`ίϚϯυͱίϚϯυϥΠϯ͔Β υΩϡϝϯτΛӾཡ͢Δ`ri`πʔϧΛಉࠝ • Ruby on RailsͰ࠾༻͞Ε͍ͯΔଞɺRubyຊମͷυΩϡϝϯτ΋RDoc ه๏Ͱॻ͔Ε͍ͯΔ
7. RDoc meets YARD
8. YARDͱ͸ • gemͷυΩϡϝϯςʔγϣϯͳͲʹ޿͘࢖ΘΕ͍ͯΔυΩϡϝϯςʔ γϣϯπʔϧ • ඪ४Ͱ͸ͳ͍ͷͰผ్Πϯετʔϧ͕ඞཁ • `@param`ͳͲΛ࢖ͬͨه๏Ͱ͋Γɺಠࣗͷܕهड़΋Մೳ • RDoc΋ύʔε͢Δ͜ͱ͕Ͱ͖Δ • ݸਓతʹ΋YARDΛ࢖͏͜ͱ͕ଟ͍
10. πʔϧͷ෼அ
12. 2023೥
13. ࣗ࡞ υΩϡϝϯςʔ γϣϯπʔϧ
14. ͦͷ࣌఺Ͱͷ͓͓͘Βͷߟ͑ • υΩϡϝϯτΛॻ͘ͷ͸ָ͘͠ͳ͍ • طଘͷυΩϡϝϯςʔγϣϯπʔϧʹ͸໰୊͕͋Δ • RDoc΋YARD΋ϝϯςφϯεঢ়گ͕ྑ͘ͳ͍ʢ࠷৽ͷRubyͷจ๏ ʹରԠ͠੾Ε͍ͯͳ͍ͳͲʣ • ৭ʑͱΞΠσΞ͕͋ΔʢRSpec͔ΒυΩϡϝϯτ࡞Εͳ͍ʁͱ͔ʣ • ৽͍͠υΩϡϝϯςʔγϣϯπʔϧΛ࡞ͬͯશ෦౷߹ͩʂ
15. ΍Γ͍ͨ͜ͱɿ πʔϧͷ౷߹ͱɺ ػೳͷ௥Ճ
16. 2024೥ RubyKaigi 2024
17. Stan Lo (st0012) “৽͍͠υΩϡϝϯςʔγϣϯπʔ ϧΛࣗ෼Ͱ࡞ΔΑΓɺRDocΛϝϯ ςφϯε͢Ε͹ɺͲ͏΍ͬͯ࢖ͬͯ ΋Β͏͔Λߟ͑Δඞཁ͕ͳ͘ͳΔ ͠ɺπʔϧ͕৽͘͠૿͑Δ͚ͩʹ͸ ͳΒͳ͍”
18. https://xkcd.com/927/ CC BY-NC 2.5
19. …͸͍
20. ʮπʔϧͷ౷߹͸ RDocΛத৺ʹ͠ ͯߦ͓͏ʯ
21. YARDͱ͸ʢ࠶ܝʣ • gemͷυΩϡϝϯςʔγϣϯͳͲʹ޿͘࢖ΘΕ͍ͯΔυΩϡϝϯςʔ γϣϯπʔϧ • ඪ४Ͱ͸ͳ͍ͷͰผ్Πϯετʔϧ͕ඞཁ • `@param`ͳͲΛ࢖ͬͨه๏Ͱ͋Γɺಠࣗͷܕهड़΋Մೳ • RDoc΋ύʔε͢Δ͜ͱ͕Ͱ͖Δ • ݸਓతʹ΋YARDΛ࢖͏͜ͱ͕ଟ͍
22. YARDͰ ͍͍ͷͰ͸ʁ
23. RDoc > YARD
24. ͳͥRDocͳͷ͔ • ඪ४ఴ෇͞Ε͍ͯΔͷͰผ్ͷΠϯετʔϧͳͲ͕ෆཁ • RDoc͸ͳ͘ͳΔ͜ͱ͸ͳ͍ • CRubyͷιʔείʔυ಺ͷυΩϡϝϯτΛղऍͰ͖Δͷ͸RDocͷΈ • YARDͷϝϯςφϯεঢ়گ͕ෆ҆ • େ͖Ίͷվળ΋࠷ۙ͸গͳ͍͠ɺϝϯςφϯε͸جຊݸਓ͕͍ͯ͠ Δ
25. 2024೥9݄ ϓϩδΣΫτ࠾୒
27. ֦ுػೳج൫
28. ϓϩδΣΫτ౰ॳͷߟ͑ • ։ൃऀʹΑͬͯυΩϡϝϯςʔγϣϯπʔϧʹඞཁͱ͢Δػೳ͸ҟͳ Δͱ͍͏Ծઆ • ༷ʑͳχʔζʹର֦ͯ͠ுػೳج൫Λ࡞Δ͜ͱͰରԠ • কདྷతʹ༷ʑͳ֦ுػೳΛ࣮૷͢Δ༧ఆ • YARDܗࣜͷίϝϯτΛυΩϡϝϯτʹม׵͢Δػೳ΋֦ுػೳͷ Ұͭͱ࣮ͯ͠૷͍ͨ͠
29. ՝୊ɿ ֦ுػೳج൫ͷ ΠϯλʔϑΣʔε
30. https://github.com/ ruby/rdoc/ discussions/1257 Proposal: RDoc extension system ౰࣌ߟ͍͑ͯͨ͜ͱΛࡶʹॻ͍ͨ σΟεΧογϣϯ
31. ϝϯλʔͷ ਢ౻͞Μͱ ૬ஊ
32. ֦ுػೳಉ࢜Λ ૄ݁߹ʹ͍ͨ͠
33. ౰ॳͷΞΠσΞ • RDocຊମ͕֤λΠϛϯάͰΠϕϯτΛൃՐ • ֦ுػೳ͸ΠϕϯτΛड͚औΓॲཧΛ͢Δ • PubSubͬΆ͍࢓૊Έ
34. https://github.com/ ruby/rdoc/pull/ 1321 Πϕϯτۦಈ֦ுػೳج൫ͷ࣮૷ɺ ۩ମతͳ֦ுػೳͱͯ͠؆қతͳ YARDύʔαʔ΋࣮૷
35. େࣦഊ
36. ࢲ͕ͯ͠͠·ࣦͬͨഊ • RDocϝϯςφͷ࣮ࡍͷχʔζ΍ݒ೦ʹԠ͍͑ͯͳ͍ • ֦ுػೳج൫ͷίϯηϓτ͸ͱ΋͔͘ɺΠϯλʔϑΣʔε͸Ұ౓ܾ ΊΔͱมߋ͕ࠔ೉ͳͷͰɺܰʑܾ͘͠ఆͰ͖ͳ͍ • ࣮ࡍͷ֦ுػೳΛઌʹ࡞͔ͬͯͦ͜ΒΠϯλʔϑΣʔεΛܾΊ͍ͨ • ໨ͷલͷ໰୊ΛղܾͰ͖ͳ͍ • ֦ுػೳج൫͸ԕճΓʹͳΔ
37. Ͳ͏͢Ε͹Α͔͔ͬͨ • ઌʹYARDରԠΛ୯ମͰ΍Δ΂͖ͩͬͨ • ͔ͦ͜Β஌ݟΛநग़Ͱ͖Δ • ΋ͬͱૣΊʹಈ͘΂͖ͩͬͨ • ؾ͍ͮͨͱ͖ʹ͸2025೥ͷ3݄ • ϓϩδΣΫτ͸΄΅ऴΘΓͷ࣌ظ
39. 2025೥4݄
40. RDocͷϝϯςφ ͱ૬ஊ͢Δ
41. RubyKaigi 2025 ίʔυ࠙਌ձ
42. @ktou @st0012 @vinistock
43. ͜ͷͱ͖࿩ͨ͜͠ͱ • ֦ுػೳج൫Ͳ͏͢Δʁ • YARDରԠΛͲ͏ਐΊΔʁ
44. https://github.com/ ruby/rdoc/issues/ 1344 վΊͯRDocͱͯ͠΄͍͠΋ͷΛ· ͱΊ௚ͨ͠issue
45. ͜ͷissueͰܾ·ͬͨํ਑ • ֦ுػೳج൫͸Ұ୴์غ͢Δ • ·͍͔ͣͭ͘ͷYARDλάΛઌߦ࣮ͯ͠૷͢Δ • ࢒Γͷλά͸ઌʹRDocଆͷػೳΛ௥Ճ͢Δඞཁ͕͋ΔͨΊ • ܕʹؔͯ͠͸RBSͷαϙʔτΛ༏ઌ͢Δ • YARDͷಠࣗه๏͸αϙʔτ͞Εͳ͍Մೳੑ΋͋Δ
46. YARD࣮૷ͷํ਑ • rdoc gem͸yard gemʹґଘͰ͖ͳ͍ • YARDλάͷύʔε͸खॻ͖ • RDocʹ͸tomdocͱ͍͏ϑΥʔϚοτΛαϙʔτ͢ΔͨΊͷ࢓૊Έ͕ ͋ΔͷͰɺྲྀ༻Ͱ͖Δ͔΋
47. 2025-08-26
48. https://github.com/ ruby/rdoc/pull/ 1416 `@yield`, `@private`, `@api private`Λ ࣮૷͠ɺRDocͷಉ౳ػೳͰ͋Δ͔ ͷΑ͏ʹৼΔ෣͏Α͏ʹͨ͠ ֦ுੑ͸ಛஈߟྀͤͣɺҰ൪୹͍࣮ ૷Λબ୒ CI͕௨ͬͨʢࠓ೔ʣ
49. ࠓޙͷ՝୊ͱ ΍Γ͍ͨ͜ͱ
50. RDocͰ΍Γ͍ͨ͜ͱ • YARDରԠΛ׬੒ͤ͞Δ • yard gemΛ࢖Θͳ͍ͰYARDܗࣜͷίϝϯτ͔ΒHTMLυΩϡϝϯ τΛੜ੒Ͱ͖Δঢ়ଶʹ͢Δ • ଞͷυΩϡϝϯςʔγϣϯπʔϧ͔Βྑ͍ॴΛநग़͢Δ • Sphinx, TypeDoc, RustDoc, Docusaurus, etc. • ಛʹdoctest͸RubyίϛϡχςΟʹड͚ೖΕΒΕΔͷ͔ڵຯ͋Γ
52. ಛʹClaude Code ʢ2025೥4݄ʣ
53. ΍ΕΔ͜ͱ͕ ૿͑ͨ…ʁ
54. ੜ੒AI͕ॿ͚ʹͳΓͦ͏ͳ͜ͱ • ໢ཏతͳςετεΠʔτͷ࡞੒ • ෳࡶͳطଘίʔυͷಡղิॿ • ଞͷπʔϧͷௐࠪ
55. ँࣙ
56. ϝϯλʔͷਢ౻͞Μ RubyΞιγΤʔγϣϯͷօ༷
57. ͋Γ͕ͱ͏͍͟͝ ·ͨ͠ʂʂʂʂʂ
58. ࠓޙ΋RDocʹ औΓ૊ΜͰ ͍͖·͢