Rails アノテーションとはなんですか？

Question

Railsを学習しています。

アノテーションという用語がでてきたのですが、よくわかりません。

これはなんでしょうか？

Answer 1

主に、コードの遣り残しをメモすることです。

コード中に

#TODO:

といれると、

def validate_each(record, attribure, value)
#TODO:
end

とします。

rake notes

コマンドで、参照できます。

Answer 2

私も知らなかったので、調べてみました。
２つの情報をみつけました。
質問がどちらのものを差しているかは、私には不明ですが。

railsで便利なライブラリannotateを発見。

　...
すごい便利なライブラリをみつけたので紹介。annotateというライブラリ。
modelで、なんのテーブルをつくったか、つまりスキーマ情報がmodelファイルの中でわかるようにする。
...

Railsの設定情報

　...
【COLUMN】コードのやり残しをメモする - TODO、FIXME、OPTIMIZEアノテーション -
TODO、FIXME、OPTIMIZEアノテーションを利用することで、開発中にやり残した事柄や、将来的に対応すべき案件を、あとから対応の忘れがないようにコード中にマーキングしておくことができます。具体的には、「# XXXX:」のようなコメント構文を利用して、以下のように記述します（XXXXはTODO、FIXME、OPTIMIZEのいずれか）。

アノテーションはrake notesコマンドで列挙できます。
特定のアノテーションだけを利用したい場合は、rake notes:todo、rake notes:fixme、rakenotes:optimizeも利用できます。
...

Comments

[honmake]

ありがとうございました！