Special Notes pada Komentar Kode Rails

Artikel ini bersumber dari rubyquicktips, dimana menjelaskan bahwa dalam memberikan komentar pada kode Rails, bisa dibuat special notes seperti TODO, FIXME, dan OPTIMIZE. Misal:

class Author < ActiveRecord::Base
  # TODO add name validaton
  # FIXME method A is not working
  # OPTIMIZE improve method B 

  has_many :articles
  ....
end

Untuk melihat seluruh special notes ini, jalankan perintah:

$ rake notes

Untuk melihat seluruh TODO.

$ rake notes:todo

Untuk melihat seluruh FIXME.

$ rake notes:fixme

Untuk melihat seluruh OPTIMIZE.

$ rake notes:optimize