YARD cheatsheetYou signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
Rubyã§å®šç¾©ã—ãŸãƒ¡ã‚½ãƒƒãƒ‰ã®ä½¿ç”¨ä¾‹ã‚’YARD用ã®ãƒ‰ã‚ュメントã¨ã—ã¦æ›¸ã方法 - 2013-09-19 - ククãƒã‚°
ã¯ã˜ã‚ã« YARDã¨ã„ã†Ruby用ã®ãƒ‰ã‚ュメンテーションツールãŒã‚ã‚Šã¾ã™ã€‚APIã®ãƒ‰ã‚ュメントã®è¨˜è¿°æ–¹æ³•ã¯å¤§ãã2種類ã‚ã‚Šã¾ã™ãŒã€YARDã¯ã‚³ãƒ¼ãƒ‰ã«ã‚³ãƒ¡ãƒ³ãƒˆã¨ã—ã¦ãƒ‰ã‚ュメントを埋ã‚込む形å¼ã‚’採用ã—ã¦ã„ã¾ã™ã€‚専用ã®è¨˜æ³•ã‚’使ã£ã¦æ§‹é€ 化ã•ã‚ŒãŸèªã¿ã‚„ã™ã„ドã‚ュメントを書ã‘ã‚‹ã“ã¨ãŒé¡žä¼¼ãƒ„ールã§ã‚ã‚‹RDocã¨ã®å¤§ããªé•ã„ã§ã™ã€‚ 今回ã¯ã€ŒRubyã§å®šç¾©ã—ãŸãƒ¡ã‚½ãƒƒãƒ‰ã®ä½¿ç”¨ä¾‹ã‚’示ã™ã€ãƒ‰ã‚ュメントã®YARDæµã®æ›¸ã方を紹介ã—ã¾ã™ã€‚ ãªãœä½¿ç”¨ä¾‹ã®æ›¸ã方を説明ã™ã‚‹ã‹ã¨ã„ã†ã¨ã€ä½¿ç”¨ä¾‹ã‚’1ã¤ç¤ºã™ã ã‘ã§ä½¿ã„方をãã£ã¨ã‚ã‹ã‚Šã‚„ã™ã説明ã™ã‚‹ã“ã¨ãŒã§ãã‚‹ã‹ã‚‰ã§ã™ã€‚ã‚‚ã¡ã‚ã‚“ã€å¼•æ•°ã‚„戻り値ãªã©ãƒ¡ã‚½ãƒƒãƒ‰ã«ã¤ã„ã¦ã®æƒ…å ±ã‚‚å¿…è¦ã§ã™ãŒã€ãれらã¯æ–片的ãªæƒ…å ±ãªãŸã‚ã€ãã“ã‹ã‚‰å…¨ä½“åƒã‚’イメージã™ã‚‹ã«ã¯ã‚‚ã†ã²ã¨ã‚¹ãƒ†ãƒƒãƒ—å¿…è¦ã«ãªã‚Šã¾ã™ã€‚一方ã€ä½¿ç”¨ä¾‹ã¯è©³ç´°ã‚’示ã™ã“ã¨ã«ã¯ä¸å‘ãã§ã™ãŒã€ã©ã‚“ãªçŠ¶æ³ã§ä½¿ã†ã®ã‹ã€ã©ã®ã‚ˆã†ã«æº–å‚™ã—ã¦ä½¿ã†ã®ã‹ã¨ã„ã£ãŸå‰å¾Œé–¢ä¿‚ã‚‚
Rails/Rubyドã‚ュメントをã‚レイã«ç”Ÿæˆã™ã‚‹YARDã€æ—©è¦‹è¡¨ä»˜ãï¼ã€€
Rubyã‚„Railsã®ãƒ‰ã‚ュメントを生æˆã™ã‚‹Gem YARDã‚’ã”å˜ã˜ã§ã™ã‹ï¼Ÿ ドã‚ュメント生æˆGemã§ã¯rDocãŒä¸å‹•ã®ä¸€ç•ªã™ãŒã€ãã®å¾Œã‚ã§çŒ›è¿½ã—ã¦ã„ã‚‹YARDã¨ã„ã†GemãŒã‚ã‚Šã¾ã™ã€‚今回ã¯ã“ã®Gemã®ç´¹ä»‹ã§ã™ã€‚ (02/16 23:30) Ruby 2.1ã§å‹•ä½œç¢ºèªã—ã¤ã¤ãƒªãƒ‹ãƒ¥ã‚¢ãƒ¼ãƒ« 🀠Gemã®ã‚¤ãƒ³ãƒˆãƒYARDã¯Rubyã®ãƒ‰ã‚ュメント生æˆrDocã®æ¬¡ä¸–代を期待ã•ã‚Œã¦ã„ã‚‹Gemã§ã™ã€‚ Ruby/Railsã®ã‚³ãƒ¼ãƒ‰å†…ã«YARDã®æ›¸å¼ã§ã‚³ãƒ¡ãƒ³ãƒˆã‚’書ãã¨ã€ãƒ¡ã‚½ãƒƒãƒ‰ã‚„引数ã€æˆ»ã‚Šå€¤ãªã©ã®è§£èª¬ã‚’ã†ã¾ã表示ã—ã¦ãã‚Œã¾ã™ã€‚ ã¾ãšGemをインストールã—ã¾ã™ã€‚
YARD - A Ruby Documentation Tool
What Is YARD? YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Above is a highlight of the some of YARD's notable features. And of course YARD comes with muc
1
リリースã€éšœå®³æƒ…å ±ãªã©ã®ã‚µãƒ¼ãƒ“スã®ãŠçŸ¥ã‚‰ã›
最新ã®äººæ°—エントリーã®é…ä¿¡
j次ã®ãƒ–ックマーク
kå‰ã®ãƒ–ックマーク
lã‚ã¨ã§èªã‚€
eコメント一覧を開ã
oページを開ã
{{#tags}}- {{label}}
{{/tags}}