Posted at

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

More than 5 years have passed since last update.


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


概要

Rubyのソースコード中に

# ANNOTATION: comment

のようなフォーマットで記述して、残タスクや要改善個所に関するコメントを残します。

具体例

# FIX: hogeメソッドがnilに対応していないので修正する

tmp = hoge(name)

Railsでは rake notes でこのアノテーションコメントをリスト表示してくれる機能がついています。

(対象は OPTIMIZE , FIXME , TODO )。

任意のキーを追加したい場合は、環境変数 ANNOTATION に追加しておきます。

$ rake notes

app/controllers/people_controller.rb:
* [6] [TODO] todo
* [7] [FIXME] fixme

※最初の括弧内の数字は行数


一覧

よく使われるアノテーションコメントは下記です。(Ruby Style Guildeより)

キーワード
内容

TODO
あとで追加すべき不足している機能を記す

FIXME
修正すべき壊れたコードを記す

OPTIMIZE
パフォーマンスに影響を与える最適化すべき箇所を記す

HACK
リファクタリングすべきコードの臭いのする箇所を記す

REVIEW
レビューすべき箇所を記す


参照


  • Ruby Style Guide

https://github.com/bbatsov/ruby-style-guide


  • Railsのrakeタスクのソースコード

https://github.com/rails/rails/blob/master/railties/lib/rails/tasks/annotations.rake