YARD
をテンプレートにして作成
[
トップ
] [
新規
|
一覧
|
検索
|
最終更新
|
ヘルプ
|
ログイン
]
開始行:
&tag(YARD);
*目次 [#w516d8a6]
#contents
*関連ページ [#pc54e23a]
*参考情報 [#y4c11f7a]
-[[YARD - A Ruby Documentation Tool:https://yardoc.org/]]
-[[YARD cheatsheet:https://gist.github.com/chetan/1827484]]
*概要 [#j68b3533]
-Rubyのドキュメントツール。
-標準のRubyDoc停滞期に開発された。
-2022/06/20(月)現在RubyDocとYARDどっちが優勢か不明。
-IntelliJ/RubyMineがどっちもに対応しているのでとりあえずY...
*書式 [#rfa637e4]
**クラス、モジュール [#uabafe6d]
- 1行コメントのみ。@author入れてもいいけど特になくてもい...
- モジュール
#pre{{
# Namespace for classes and modules that handle serving d...
#
# @since 0.6.0
}}
- クラス
#pre{{
# Abstract base class for CLI utilities. Provides some he...
# the option parser
#
# @author Full Name
}}
**メソッド [#m0edea50]
- 1行コメント@paramと@returnがあったらよさげ
#pre{{
# An alias to {Parser::SourceParser}'s parsing method
#
# @option opts [String] :subject The subject
# return the object
}}
*** @example [#pa4acfb3]
-@exampleの使用例を使う場合
#pre{{
# Generates Array containing numbers exceeding limit_age....
# members of ages.
#
# @example extract ages over 40
# overages = extract_overage([17, 43, 40, 56], 40)
# puts("overages: #{overages.join(", ")}") #=> "overage...
#
#
# @param ages [Array] numbers checked if they exceeded fr...
# @param limit_age [Integer] limit_age limit used to extr...
# bigger ages than it.
# @return [Array] Returns Array containing numbers exceed...
def extract_overage(ages, limit_age=20)
}}
*** @return [#vd366d4b]
-参考。 [[YARD - A Ruby Documentation Tool:https://yardoc...
-複数の値を返す。真偽値と数値という固定長配列を返したい場合
#pre{{
# @return [Array(Boolean, Number)] fixed-size array(vecto...
def foo
[true_or_false, some_integer]
end
}}
-複数のタイプからなる可変長配列を返したい場合
# @return [Array<String, Symbol, #read>] an Array of (St...
*IntelliJ/RubyMineのサポート [#k6e05ac1]
-[[コードのドキュメント化 | RubyMine:https://pleiades.io/...
-メソッドをハイライトしてOption+Enterで@paramタグを追加で...
-Control+Option+Qでレンダリングの切替
-独自の@typeあのエーションを使うこともできる。
#pre{{
# @type [Integer]
customer_id = 1
# @type [String] customer_name
customer_name = "Andrew Fuller"
}}
終了行:
&tag(YARD);
*目次 [#w516d8a6]
#contents
*関連ページ [#pc54e23a]
*参考情報 [#y4c11f7a]
-[[YARD - A Ruby Documentation Tool:https://yardoc.org/]]
-[[YARD cheatsheet:https://gist.github.com/chetan/1827484]]
*概要 [#j68b3533]
-Rubyのドキュメントツール。
-標準のRubyDoc停滞期に開発された。
-2022/06/20(月)現在RubyDocとYARDどっちが優勢か不明。
-IntelliJ/RubyMineがどっちもに対応しているのでとりあえずY...
*書式 [#rfa637e4]
**クラス、モジュール [#uabafe6d]
- 1行コメントのみ。@author入れてもいいけど特になくてもい...
- モジュール
#pre{{
# Namespace for classes and modules that handle serving d...
#
# @since 0.6.0
}}
- クラス
#pre{{
# Abstract base class for CLI utilities. Provides some he...
# the option parser
#
# @author Full Name
}}
**メソッド [#m0edea50]
- 1行コメント@paramと@returnがあったらよさげ
#pre{{
# An alias to {Parser::SourceParser}'s parsing method
#
# @option opts [String] :subject The subject
# return the object
}}
*** @example [#pa4acfb3]
-@exampleの使用例を使う場合
#pre{{
# Generates Array containing numbers exceeding limit_age....
# members of ages.
#
# @example extract ages over 40
# overages = extract_overage([17, 43, 40, 56], 40)
# puts("overages: #{overages.join(", ")}") #=> "overage...
#
#
# @param ages [Array] numbers checked if they exceeded fr...
# @param limit_age [Integer] limit_age limit used to extr...
# bigger ages than it.
# @return [Array] Returns Array containing numbers exceed...
def extract_overage(ages, limit_age=20)
}}
*** @return [#vd366d4b]
-参考。 [[YARD - A Ruby Documentation Tool:https://yardoc...
-複数の値を返す。真偽値と数値という固定長配列を返したい場合
#pre{{
# @return [Array(Boolean, Number)] fixed-size array(vecto...
def foo
[true_or_false, some_integer]
end
}}
-複数のタイプからなる可変長配列を返したい場合
# @return [Array<String, Symbol, #read>] an Array of (St...
*IntelliJ/RubyMineのサポート [#k6e05ac1]
-[[コードのドキュメント化 | RubyMine:https://pleiades.io/...
-メソッドをハイライトしてOption+Enterで@paramタグを追加で...
-Control+Option+Qでレンダリングの切替
-独自の@typeあのエーションを使うこともできる。
#pre{{
# @type [Integer]
customer_id = 1
# @type [String] customer_name
customer_name = "Andrew Fuller"
}}
ページ名:
![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
