Edge Rails 的更新:源代码注释

Posted by yudi
on Thursday, December 13


这里所说的注释并不是您在 Java或C# 中所看到那样密集的注释 – 这里将介绍一个记录 todo 的方法,以及其他有助于思维提示 的经验。请看下面一段代码:

1
2
3
4
5
6
7
8
9
class ContactsController < ApplicationController
  
  # TODO: 添加动态支持
  # OPTIMIZE: 优化这行代码
  # FIXME: 这里有问题
  def index
    ...
  end
end

利用新的 rake 任务,我们现在可以吐出一列注释:

1
2
3
4
5
rake notes
app/controllers/contacts_controller.rb:
  * [ 3] [TODO] 
  * [ 4] [OPTIMIZE] 
  * [ 5] [FIXME] 

您也只能调用一系列特定类别的rake记录如: rake notes:todo, rake notes:optimize 以及 rake notes:fixme。

提示:JD 知道如何将这个rake任务安装在稳定的(非edge) Rails应用程序上,感谢JD!

1
2
cd lib/tasks && \
  wget http://dev.rubyonrails.org/export/7553/trunk/railties/lib/tasks/annotations.rake

原文作者是 Ryan Daigle, 请访问他的博客
本片译文的原文地址:http://ryandaigle.com/articles/2007/2/26/what-s-new-in-edge-rails-source-code-annotations

Comments

Leave a response