YARD の履歴(No.2)

• 履歴一覧
• 差分 を表示
• 現在との差分 を表示
• ソース を表示
• YARD へ行く。
  • 1 (2022-06-20 (月) 13:24:12)
  • 2 (2022-06-20 (月) 14:10:41)

Tag: YARD

目次†

関連ページ†

参考情報†

• YARD - A Ruby Documentation Tool
• YARD cheatsheet

概要†

• Rubyのドキュメントツール。
• 標準のRubyDoc停滞期に開発された。
• 2022/06/20(月)現在RubyDocとYARDどっちが優勢か不明。
• IntelliJ/RubyMineがどっちもに対応しているのでとりあえずYARDに従ってドキュメントかいとくか？

書式†

クラス、モジュール†

• 1行コメントのみ。@author入れてもいいけど特になくてもいいか。
• モジュール

  # Namespace for classes and modules that handle serving documentation over HTTP
  #
  # @since 0.6.0
  

• クラス

  # Abstract base class for CLI utilities. Provides some helper methods for
  # the option parser
  # 
  # @author Full Name
  

メソッド†

• 1行コメント@paramと@returnがあったらよさげ

  # An alias to {Parser::SourceParser}'s parsing method
  #
  # @option opts [String] :subject The subject
  # return the object
  

• @exampleを使う場合

  # Generates Array containing numbers exceeding limit_age. Numbers is
  # members of ages.
  #
  # @example extract ages over 40
  #   overages = extract_overage([17, 43, 40, 56], 40)
  #   puts("overages: #{overages.join(", ")}") #=> "overages: 43, 56"
  #
  #
  # @param ages [Array] numbers checked if they exceeded from limit_age.
  # @param limit_age [Integer] limit_age limit used to extract
  #   bigger ages than it.
  # @return [Array] Returns Array containing numbers exceeding limit_age.
  def extract_overage(ages, limit_age=20)
  

IntelliJ/RubyMineのサポート†

• コードのドキュメント化 | RubyMine
• メソッドをハイライトしてOption+Enterで@paramタグを追加できる。
• Control+Option+Qでレンダリングの切替
• 独自の@typeあのエーションを使うこともできる。

  # @type [Integer]
  customer_id = 1
  # @type [String] customer_name
  customer_name = "Andrew Fuller"