A suggestion for the future of RDoc

https://matsue.rubyist.net/matrk11/ での発表資料です。

Transcript

1. RDocͷվળҊΛͻͨ͢Β͠Ό ΂Δ͚ͩ দߐRubyձٞ11 2024-10-05, OKURA Masafumi
2. RDocͷվળҊΛͻͨ͢Β͠Ό ΂Δ͚ͩ RDocͷ՝୊੔ཧ দߐRubyձٞ11 2024-10-05, OKURA Masafumi
3. Dev.introduce self • ໊લɿେ૔խ࢙ʢ͓͓͘Β·͞;Έʣ • ॴଐɿϑϦʔϥϯε • ՝֎׆ಈɿKaigi on RailsνʔϑΦʔΨφΠβʔɺ”OH! MY RUBYISTS” ϙουΩϟετओ࠻ɺAlba࡞ऀͳͲ • দߐͱࢲɿদߐʹདྷΔͷ͸3ճ໨ʢ2019, 2023ʣɺ12݄ʹ΋দߐʹདྷ ·͢
7. RDoc
8. “RDoc produces HTML and command-line documentation for Ruby projects. RDoc includes the rdoc and ri tools for generating and displaying documentation from the command-line.”
9. ʮRDoc͸RubyϓϩδΣΫτ޲͚ͷ HTML/ίϚϯυϥΠϯυΩϡϝϯτΛ ੜ੒͠·͢ɻRDocʹ͸ίϚϯυϥΠ ϯ͔ΒυΩϡϝϯτΛੜ੒ɾදࣔ͢Δ rdocͱriπʔϧؚ͕·Ε͍ͯ·͢ɻʯ ੿༁
10. ʲॏཁʳ RDoc͸3.3ܥͰ͸ default gem
11. RDoc͸ඪ४Ͱ ࢖͑Δݱ࣌఺Ͱ །Ұͷ υΩϡϝϯτπʔϧ
12. ʲॏཁʳ RDoc͸ ࣺͯΒΕͳ͍
13. RubyͷCίʔυ͸ RDocͰύʔε ͢Δඞཁ͕͋Δ
14. RDocΛ վળ͢Δඞཁ ͕͋Δ
15. YARD͸ʁ
16. ͦΕ͸ͦΕ ϝϯςφϯεঢ়گ΋ͦ͜·Ͱྑ͘ͳ͍
17. RDocͱΘͨ͠
18. Back to 2020…
19. Albaͷ։ൃ
20. Ruby͸ͱͯ΋ շదͰָ͍͠
21. YARD
23. ָ͘͠ͳ͍
24. ΋ͬͱྑ͍ํ๏͕ ͋ΔͷͰ͸ʁ
26. Niwa
27. New Integrated Working Annotations
28. New Integrated Working Annotations
29. ֤छπʔϧͱ υΩϡϝϯτͷ ౷߹
30. ྫ͑͹ܕ
31. ʮRBS͕͋Δͷʹ ͳΜͰYARDͷܕ Λॻ͍͍ͯΔʁʯ
32. RubyKaigi 2024 Day3
33. όʔʹͯ
34. Stan Lo
35. ʮͳΜ͔υΩϡϝϯτͷ͜ ͱ΍ͬͯΔΈ͍͚ͨͩͲɺ Ͳ͏ͤͳΒRDoc΍ͬͨ΄͏ ͕ϢʔβʔʹӨڹΛ༩͑Β ΕΔΑʯ
36. ࣗ෼ʮͦ͏͔΋ʯ
37. RDocͷ՝୊
38. RDocͷ՝୊ • ܕγεςϜʢͱ͍͏͔rbs-inlineʣͱͷ౷߹ • σΟϨΫςΟϒ͕೉ͯ͘͠දݱྗ͕௿͍ • YARDͷλά͕࢖͍͍ͨ • ֦ுੑ͕௿͍ • ྫ͑͹LSP͔Β৮Γ͍ͨͱ͖ʹͲ͏͢Δʁ
39. ܕγεςϜͱͷ ౷߹
40. rbs-inline
41. RDocʹͱͬͯ͸ ݱঢ়ͨͩͷจࣈྻ
42. https://github.com/soutaro/rbs-inline/issues/8
43. “1. Supporting some YARD syntaxes that can easily be used for type de fi nition, like @param and @return 2. Providing a YARD plugin to support converting @rbs methods for documentation generation”
44. rbs-inline YARD
45. rbs-inline RDoc
46. σΟϨΫςΟϒ ͱ λά
47. σΟϨΫςΟϒ ͱ͸
48. :nodoc:
49. σΟϨΫςΟϒ͸ RDocͷڍಈΛ ੍ޚ͢Δ
50. λάͱ͸
51. @param @return @since
52. RDocʹ͸ λά͕ͳ͍
53. σΟϨΫςΟϒ͸ ݸผͷίʔυͷ Ξϊςʔγϣϯʹ ޲͔ͳ͍ ※ݸਓͷݟղͰ͢
54. λά΄͍͠ʂ
55. ͱ͍͏͔ YARDه๏͕ ΄͍͠ʂ
56. ͦ΋ͦ΋ࣗ෼ͨͪͷ ϓϩμΫτ͸YARDͰ ίϝϯτΛॻ͍͍ͯΔ
57. RDoc͕YARDΛ ཧղ͢Ε͹ Α͍ͷͰ͸ʁ
58. RDocͷ֦ுੑ
59. ྫ͑͹RDocʹ ύʔαʔΛ௥Ճ ͍ͨ͠
61. ೉͍͠
62. υΩϡϝϯτԽ ͞Εͯͳ͍ ʢRDocͳͷʹʣ
63. ύʔαʔ ͚ͩ͡Όͳ͍
64. ৭ʑͳ΋ͷͨͪ ͱ࿈ܞ͍ͨ͠
65. ৭ʑͳ΋ͷͨͪ ʹΑ֦ͬͯுͰ͖ ΔΑ͏ʹ͍ͨ͠
66. ʮϓϥάΠϯʯ తͳAPI͕΄͍͠
67. ύʔαʔͷ௥Ճ ʢYARDͳͲʣ
68. ίʔυ ΦϒδΣΫτͷ ֦ு
69. ग़ྗઌͷ ௥Ճ ʢLSPͳͲʣ
70. https://github.com/ruby/rdoc/issues/1178
71. ·ͱΊɿ ϑϨʔϜϫʔΫ ͱͯ͠ͷRDoc
72. υΩϡϝϯτ΁ͷ ཁٻ͸૿େ ͍ͯ͠Δ
73. ʲ͓·͚ʳ AI knows what, but not why
74. ʲ͓·͚ʳ ίʔυͷഎܠ͸ ਓ͕ؒॻ͔͘͠ͳ͍
75. RDoc
76. །Ұͷެࣜ υΩϡϝϯτ πʔϧ
77. ͯ͜ೖΕ͍ͨ͠
78. ՝୊͸ݱ৔ʹ ΑͬͯҟͳΔ
79. ҟͳΔݱ৔ʹҟͳΔ՝୊ • Rails APIΛ࡞͍ͬͯΔνʔϜ • ͔ͤͬ͘υΩϡϝϯτΛ࡞ͬͯ΋ϝϯς͞Εͳ͍ • Gem࡞ऀ • ܕఆٛͱυΩϡϝϯτΛ౷߹͍ͨ͠ • Rubyݴޠ։ൃऀ • ݶΒΕͨίϝϯτεϖʔεΛ༗ޮར༻͍ͨ͠ʢʁʣ
80. ҟͳΔ՝୊ʹҟͳΔղܾࡦ • ͔ͤͬ͘υΩϡϝϯτΛ࡞ͬͯ΋ϝϯς͞Εͳ͍ • ྫ͑͹ࣗࣾͷطଘυΩϡϝϯτͱ౷߹͢ΔͨΊͷRDocϓϥάΠϯ • RSpecͷ಺༰Λύʔεͯ͠υΩϡϝϯτԽ͢ΔRDocϓϥάΠϯ • ܕఆٛͱυΩϡϝϯτΛ౷߹͍ͨ͠ • .rbsϑΝΠϧʹॻ͔Εͨ಺༰ΛύʔεͰ͖ΔRDocϓϥάΠϯ • ݶΒΕͨίϝϯτεϖʔεΛ༗ޮར༻͍ͨ͠ʢʁʣ • ঢ়گʹ߹ΘͤͯϓϥάΠϯΛ෇͚ସ͑Δʢʁʣ
81. ࠷ऴ໨ඪɿ
82. υΩϡϝϯτ΋ ָ͘͠ॻ͚Δ Α͏ʹͳΔ
83. ͨͷ͍͠RDoc