質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.98%

  • Ruby

    6398questions

    Rubyはプログラミング言語のひとつで、オープンソース、オブジェクト指向のプログラミング開発に対応しています。

YARDで出力できない関数があるので改善したい

解決済

回答 1

投稿

  • 評価
  • クリップ 0
  • VIEW 109

momijiMac

score 29

発生している問題・エラーメッセージ

下記のコードで 関数dotがyardでドキュメント化されないので困っています。
関数strはきちんとドキュメント化されています。

 コマンド

yardoc sample.rb

該当のソースコード

file: sample.rb

# String extensions
module StringExtension

  refine String do

    # Combine strings by dot(.).
    # @example
    # "sample".dot("is_test") => "sample.is_test"
    def dot(str)
      self + "." + str
    end

  end

  # This is test func
  # @return [string] just "test"
  def str()
    p "test"
  end

end

補足情報(言語/FW/ツール等のバージョンなど)

ruby 2.4.0p0 (2016-12-24 revision 57164) [x86_64-darwin15]
yard 0.9.12

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

+1

こんにちは。

2014年のissue ですが yard のレポジトリで以下を見つけました。

YARD does not generate documentation for refinements #780

上記で作者さんは

YARD does not (yet) support refinements. 

と言っています。

とりあえずの策として、このissueを投稿した方が、

I've found (I think) a partial workaround:

と言っている、
https://github.com/lsegal/yard/issues/780#issuecomment-45232202

にならって、

# String extensions
module StringExtension

    # @!method dot(str)
    # Combine strings by dot(.).
    # @example
    # "sample".dot("is_test") => "sample.is_test"

  refine String do

    def dot(str)
      self + "." + str
    end

  end

  # This is test func
  # @return [string] just "test"
  def str()
    p "test"
  end

end

としてやると、一応出るには出ましたが、
以下のような、ちょっと不満の残る感じ
になりました。

イメージ説明

上記の issue 以外で、refinements について議論している
issue は無いようでした。

以上参考になれば幸いです。

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 90.98%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る

  • Ruby

    6398questions

    Rubyはプログラミング言語のひとつで、オープンソース、オブジェクト指向のプログラミング開発に対応しています。