2

これは私のセットアップです：

  • ルビー 1.9.2 p290
  • ヤード 0.8.1

フォルダー構造は gem ではなく、単純な古い Ruby コードです。

.
├── classes
│   ├── crawl.rb
│   └── page.rb
└── run.rb

問題は、ヤードがファイルを認識しないことです。

yard doc次の出力が得られます。

 Files:           0
 Modules:         0 (    0 undocumented)
 Classes:         0 (    0 undocumented)
 Constants:       0 (    0 undocumented)
 Methods:         0 (    0 undocumented)
 0.00% documented

ファイルが表示されない、または表示されない理由

編集（追加情報）：

ヤードには、ファイルを作成する権限があります。

コマンドを実行するyard docと、ディレクトリに yard ファイルが表示されます。

.       ..      .yardoc classes doc     run.rb

編集 (rdoc に関するコメントへの応答)

ヤードが作成する doc フォルダーを削除すると (rdoc はそれについて文句を言います) rm -rf doc、rdoc はドキュメントを生成し、この出力を提供します

 Files:       7

 Classes:     6 ( 4 undocumented)
 Modules:     0 ( 0 undocumented)
 Constants:   2 ( 2 undocumented)
 Attributes: 18 (18 undocumented)
 Methods:    24 (20 undocumented)

 Total:      50 (44 undocumented)
  12.00% documented

編集 (追加情報)

Yard は、MRI 1.8.7 や jRuby 1.6.4 などの他の Ruby ビルドでは機能しません。上記と同じように動作します

4

1 に答える 1

3

Yard は、ディレクトリ構造内のすべての ruby​​ ファイルを自動的に文書化するわけではありません。./libディレクトリ内のファイルを探します。他のものを文書化したい場合は、コマンドまたは .yardopts ファイルでそれを指定する必要があります

例 yard classes/*.rb *.rb

于 2012-05-19T04:18:57.897 に答える