Ruby 코멘트(주석) TODO, FIXME, OPTIMIZE, HACK, REVIEW 에 대해

요즘 Ruby를 공부해보면서 Ruby뿐만 아니라 ,PHP도 그렇고 자바스크립트, CSS, HTML 다 Ruby 스타일 가이드 에서 제시한대로 코멘트다는 습관을 들이고 있다.

# FIXME: 변수명 수정해야 한다.
test_mail = get_user_mail


# TODO: 거짓일 경우 다른 문자열을 넣는다. 
if test_user?
  test_mail = 'test@ccc.com'
else
  test_mail = ''
end

( * 사실 쓰는건 거의 TODO, FIXME 이 두개였다.)

Rails 에서는 rake notes 라고 만 하면 코멘트 리스트를 표시해준다.

TODO, FIXME, OPTIMIZE 의 경우만 표시된다는것에 유의하자.

“[코드라인] [코멘트종류] : 코멘트” 의 형태

$ bundle exec rake notes

app/models/booking_select_schedule.rb:
  * [4] [TODO] initialize 할때 기본 값 채워 넣도록 하자.

app/models/permission.rb:
  * [3] [TODO] :dependent 속성 destroy 안되는 이유 알아내야 한다.

app/models/role.rb:
  * [4] [TODO] :dependent 속성 destroy 안되는 이유 알아내야 한다.

주로 사용되는 코멘트리스트

• TODO: 나중에 추가하거나 부족한것이 있는 부분
• FIXME: 수정되어야 할 부분
• OPTIMIZE: 퍼포먼스에 영향을 주는 부분
• HACK: 리펙토링 되어야 할 부분
• REVIEW: 리뷰해야 할 부분

앞으로는 OPTIMIZE, HACK, REVIEW 등도 써야 겠다.

역시 Ruby 는 편리해

참고

Ruby | アノテーションコメント（TODO、FIXME、OPTIMIZE、HACK、REVIEW）