Javaとかで見る[TODO]とかいうやつ

// TODO 修正する

とか見ますね。
見ますよね?

これはアノテーションコメントというらしいです。

なぜこういったものをつけるのかというと、後でソースを見直した時に課題の把握が容易になるからです。

TODO付いているものを拾っておいて」とかいわれたら、ソースをgrepしたりするといいです。
grep 超重要

*** 代表的なアノテーションコメント

表記 意味
TODO あとで追加すべき不足している機能を記す
FIXME 修正すべき壊れたコードを記す
REVIEW レビューすべき箇所を記す
MEMO 実装済みであるが、後から「なぜこうしたのか」がわかるようにする

まだまだあるよね

*** 誰のコメント?

ただ

MEMO

と書くよりも

MEMO(Justin) 
MEMO(Masa.T) 

となどと、コメントの作者を書いた方が良いです。
リーダブルコードでそういっていました。

誰が書いたか、、、これも重要です。
重要なこと、多すぎです。

とりあえず詰まったらテラテイルでその道の先輩に聞くのがいいです。おすすめです。


スポンサーリンク







シェアする

  • このエントリーをはてなブックマークに追加

フォローする

スポンサーリンク