Với một lập trình viên, việc viết các annotations đôi khi cũng khá quan trọng.
Trong bài này sẽ nói về các add annotation trong Rails.
Rails hỗ trợ 3 annotation gồm: TODO, FIXME, OPTIMIZE
Cách sử dụng:
Bạn add annotation dưới dạng comment, ví dụ:
# TODO do something
Để xem danh sách các annotation bạn đã add, bạn dùng command rake notes. Lệnh này sẽ search trong code và show ra tất cả annotation gồm thông tin tên file, dòng, và mô tả. Vd:
rake notes app/controllers/contacts_controller.rb
Ngoài ra bạn có thể filter, vd chỉ list ra các annotation FIXME:
rake notes:fixme
Custom annotation
Ví dụ sử dụng custom annotation là BUG
# BUG this is a bug
Để list ra các BUG annotation:
rake notes:custom ANNOTATION=BUG
Have fun!