4

Railsのパーシャルに渡すことができるパラメーターを文書化するための標準または新しい標準はありますか?

が と で渡されるローカル var を_my_partial.html.erb期待する場合、部分的なコード全体を読むことなく、それらの名前、期待される型、および役割を文書化する共通の方法が必要です。メソッドとクラスの RDoc や Tomdoc のようなもの。ありませんか？titleelementsrender 'my_partial', title: t, elements: e

編集:パーシャルの最初の行でパラメーターを初期化することを著者が提唱している投稿<% var ||= 'default_val' %>を見つけました。これは実際に安全な方法であり、一種のコード内ドキュメントです。これに対するコメント/パラメータ宣言の解決策は本当にありませんか?

4

1 に答える 1

3

パーシャルの開始時に、参照されるすべての変数を呼び出すだけです。 

# _my_partial.html.erb
<% title %>            <---  first line of file
<% elements[0] %>

<h3><%= title %></h3>
<% elements.each do |element| %>
   <p> etc ... </p>

これがプロジェクトに適している理由:

  • コメントや非コード ファイルに依存しない
  • プロジェクトの開発者は、問題のファイルの先頭を見ることで、必要な変数をすばやく見つけることができます。
  • 変数を呼び出すことで、欠落している変数が例外になることを保証します。
  • elements は、列挙可能でない場合に爆発させたいので、角かっこで呼び出されますよね?

バグを隠すことができるため、<% var ||= 'default_val' %>実際に使用することは安全ではありません。何かが正しく行われなかった瞬間に、コードをすぐに爆発させたいとします。そして、これらの変数を渡す必要がある場合は、それらが存在しないときにコードを爆破する必要があります。

于 2012-10-19T14:46:47.157 に答える