在Rails中记录部分参数

Question

是否有任何标准或新兴标准来记录可传递给Rails部分的参数？

当_my_partial.html.erb期望title和elements本地var与render 'my_partial', title: t, elements: e一起传递时，必须有一种通用方法来记录其名称，预期类型和角色，阅读整个部分代码。类似RDoc或Tomdoc的方法和类。不存在吗？

编辑：我发现a post其作者主张在部分的第一行使用<% var ||= 'default_val' %>初始化参数，这确实是一种安全的做法和一种代码内文档。对此真的没有评论/参数声明解决方案吗？

Answer 1

在partial的开头，只需调用引用的所有变量。

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

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

这对您的项目有利的原因：

• 它不依赖于评论或非代码文件
• 项目中的任何开发人员都可以通过查看相关文件的顶部快速找出所需的变量
• 通过调用变量，确保缺少的变量将导致异常。
使用方括号调用
• 元素，因为如果它不是可枚举的话，我们也希望它会爆炸，对吧？

使用<% var ||= 'default_val' %>的做法实际上是不安全，因为它允许隐藏错误。您希望您的代码立即爆炸在某些事情没有做好的时候。如果这些变量应该通过，那么你希望代码在他们不存在的时候爆炸。