JSLintオプション考察「TODO comments」

2013年09月06日

カテゴリー:

「TODO comments」オプションは、JavaScriptコード中の「TODOコメント」を無視するかどうかを指定するオプションです。デフォルト(false)では、TODOコメントが残っている状態でコードチェックすると「Unexpected TODO comment.」という警告が表示されます。

そもそも「TODOコメント」って何よ!?

まぁ読んで字の如くだったりするのですが、私はTODOコメントを書く習慣がなかったため、最初このオプションの名前を見たとき「TODOコメントってなんぞや?」という状態でした。

早速調べてみると、要はTODOコメントって、

//TODO func関数未実装なので実装する!
function func() {}

↑のようなコメントのことで、これってJavaScriptとか関係なく、ただ単にプログラマがコード中にタスクを書き込む時の慣例(作法?)的なものだということを知りました。

ただ、このTODOコメントの良いところは、メジャーな開発ツール(eclipseとか、VisualStudioとか)はこのコメント形式(//TODO ~)をサポートしているらしく、ツールがTODOコメントを勝手に収集してきて、それをTODOリスト形式で表示してくれるそうです。

TODOコメント超便利じゃん!

・・・というわけで、私もTODOコメントを採用することにしました。。
(お恥ずかしいことですが、私はかなりアナログな方法…ExcelとかにTODOを書き込んで管理してました)


少し話が逸れましたが、本題に戻りましょう。

要はJSLint的には「TODOコメントがある」=「未完成部分がある」→「未完成なので警告を出す」ということなのでしょう。

このオプションのtrue/falseに関しては、プログラマの都合に合わせれば良いと思います。デフォルト(false)のままであれば、TODOコメントがあった際に警告が表示されるので、TODOの実装漏れに気づかせてくれるかもしれません。ですが、そもそもTODOに関しては他の開発ツール側で管理しているのであればわざわざJSLint側でもチェックする必要はないと思うので、そのような場合は true(無効)にしても良いでしょう。

JSLintのオプション一覧ページへ