ruby-on-rails - 在 Rails 中记录部分参数

标签 ruby-on-rails ruby-on-rails-3 documentation comments

是否有任何标准或新兴标准来记录可以传递到 Rails partial 的参数?

_my_partial.html.erb 需要 titleelements 局部变量时, render 'my_partial', title: t, elements: e 必须有一种通用的方法来记录它们的名称、预期类型和角色,而无需阅读整个部分代码。类似于 RDoc 或 Tomdoc 的方法和类。不是吗?

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

最佳答案

在部分开始时,只需调用所有引用的变量。

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

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

这对您的项目有益的原因:
  • 它不依赖于注释或非代码文件
  • 项目中的任何开发人员都可以通过查看相关文件的顶部来快速找出需要哪些变量
  • 通过调用变量,您可以确保丢失的变量会导致异常。
  • 元素是用方括号调用的,因为如果它不是可枚举的,我们也希望它爆炸,对吗?

  • 使用实践<% var ||= 'default_val' %>实际上是 不安全 因为它允许隐藏错误。您希望您的代码在某些地方做得不对时立即炸毁。如果应该传递这些变量,那么您希望代码在它们不存在时爆炸。

    关于ruby-on-rails - 在 Rails 中记录部分参数,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/12894839/

    相关文章:

    多编程语言 API 的文档

    xml - 在哪里可以找到或多或少完整的 Skype 支持的 XML 标记列表?

    Ruby 如何从自定义对象文档创建范围?

    ruby-on-rails - Ruby on Rails 使用 rake 任务解析 JSON 文件

    ruby - rails 3.2.2(或 3.2.1)+ Postgresql 9.1.3 + Ubuntu 11.10 连接错误

    ruby-on-rails-3 - 从 Rails 应用程序中删除 heroku 存储库

    ruby-on-rails - 新手问题 : Class and instance methods in Ruby on Rails

    ruby-on-rails - rails 迁移文件中的错字

    ruby-on-rails - 将 Ruby on Rails 应用程序部署到 Google App Engine

    ruby-on-rails - Rails 3 SSL 弃用