YARD(Ruby)

コード中のコメントでRubyのドキュメンテーションをするやつ

標準にRDocってドキュメンテーションがあるけど自由度が高すぎる

引数の説明や返り値の説明なんかの項目をタグで書く

参考

code:sample.rb

# クラスの説明

class ClassName

# 普通のメソッドの説明

# @param Numeric, String, nil arg1 クラス名、引数名、説明を半角空白区切りで書く

# @param true, false arg2 クラス名の中で true, false, nil だけはこのまま書く(Ruby に bool ってクラスは無い)

# @return Object 返り値

# @raise Exception 例外の説明

def method_name(arg1, arg2)

# 何らかの処理

end

# @private ドキュメントに載せない部分はこのタグ

def initialize

# 何らかの処理

end

# @!attribute r var

# @return Object 説明

attr_reader :var

# @abstract オーバーライドする用の概念メソッド

def abstract_method; end

end