yard

    4熱

    1答えて

    `README`ファイル以外のファイルをもっと文書化するには？

    私はRuby on Rails 3.1.0とYARD 0.7.4 gemをドキュメント化の目的で使用しています。 here（...、README、What's New?、Getting Started Guide、Architecture Overviewを参照してくださいタブは「ファイルリストの下のリンク先のページの一番上に作られたように私は、生成されたドキュメントの上にREADMEファイル以外
    ruby-on-rails ruby ruby-on-rails-3 documentation yard 2012-02-18

    6熱

    2答えて

    ヤード：（doc /の代わりに）コンパイルされたドキュメントの別のパスを指定しますか？

    ヤードに私のRailsプロジェクトのdoc/フォルダを乱雑にしないように指示する方法はありますか？私はそのファイルをdoc/yard/かそのようなものに保存したいと思います。悲しいことに、私はそのための選択肢を見つけられませんでした。 ありがとうございました。
    ruby yard 2012-07-26

    1熱

    1答えて

    別のYARDの記述でメソッドの戻り値を使用する動的なドキュメントですか？

    私はプロジェクトを文書化していますし、essientially私は次のようなものがあります。 def foo return bar(__method__) end def bar (method) return method.to_s + 'somestring' end を私は彼らがバーのリターンを返すされているのfooを実装しているのと同じように多数の方法を設定していま
    ruby documentation yard 2012-04-25

    3熱

    1答えて

    は、複数のファイル

    に適用されます。私は別々のファイルに持っている場合は、そのような場合のように、ドキュメントが適切に生成されていないこれらの定義を、次のように： file0.rb： require 'file1.rb' require 'file2.rb' file1.rb： module Something class Resource # Defines a new property
    ruby documentation yard 2012-04-25

    0熱

    1答えて

    ヤードック@マクロのレジスタを反復する

    ヤードックのレジスタを反復処理する方法を探しています@macro。 class Post include DataMapper::Resource # @macro dm.property # @return [$2] the $1 $0 of the post property :title, String end 、あなたはレジスタは次のようにあ
    ruby documentation yard 2012-04-27

    0熱

    1答えて

    プラグインに関するドキュメントを生成するにはどうすればよいですか？

    私はRails 3.1.0を使用しており、動作するプラグインを実装しています。それに加えて、関連ファイルはROOT_APP/vendor/plugins/my_pluginディレクトリにあります。 今、私はYARD 0.7.4の宝石を使用しており、そのプラグインを文書化したいと思います。とにかく、yardoc（またはyard doc）コマンドを実行すると、プラグインが考慮されていないように見えるの
    ruby-on-rails ruby ruby-on-rails-3 documentation yard 2012-01-20

    2熱

    1答えて

    YARDサーバーを使ってプライベートメソッドを表示するには？

    私の最初の質問--privateスイッチがyard serverのために動作しないことがわかりました。 第二に、私はyard serverを使用するのではなく、ドキュメントファイルを生成するためにyard docを使用することを選択した場合--privateスイッチは、どのようにレンダリング文書はフレーム（サイドバー）を持っている
    yard 2012-01-22

    2熱

    1答えて

    YardのドキュメントでHTML要素名を出力する方法

    Yardによって生成されたRubyクラスのドキュメントに、<label>などのHTML要素名を含める必要があります。しかし、それは動作していません。例えば、文 # Returns a <label> field... となり、ヤード Return a field... による処理後<label>要素は、実際に生のHTMLとしてブラウザにそれを作る庭を通してそのまま通過しています。 私は&l
    ruby-on-rails ruby documentation yard 2012-01-28

    8熱

    2答えて

    YARD：クラスメソッドへのリンクを作成する方法は？

    ルービークラスメソッドとYARDをリンクするにはどうすればよいですか？リンクについてはyard documentationです。 {#my_instance_method} 正常に動作します：同じ名前空間内インスタンスメソッドへのリンク 。ただし、コンパイルされませんクラスメソッドと同じアプローチを、以下、それを修正する： ObjectName#self#self.my_class_metho
    ruby-on-rails ruby documentation yard 2013-01-11

    1熱

    2答えて

    RubyDoc.infoやYARDのようなJavascriptのドキュメントジェネレータ？

    今後のJavascriptライブラリのためのすばらしいJavascriptドキュメントジェネレータが本当に必要です。明らかに、私は人々に理解させるために私の図書館の資料が必要です。私はドキュメンテーションのための良いライブラリを見つけるのに苦労しています、私は多くの異なるプロジェクトを見てきましたが、私は必要なものではありません。 JavascriptにRubydoc.infoまたはYARDスタイ
    javascript documentation yard 2012-03-23
最新の質問