『アノテーションコメント』を活用しよう

今回はソースコードにコメントを書くときに活用したい『アノテーションコメント』の内、私がよく使うものを３つ紹介します。

// TODO:

後でやらないといけないことがあるときに使っています。
使用例は以下です。

function hello(name) {
    // TODO: ダミーデータを使わずに実装する
    return “Hello, Taro”
}

// FIXME:

修正すべき点があるときに使っています。
使用例は以下です。

function add(num1, num2) {
    // FIXME: 引数が異常値のときエラーになる
    return num1 + num2
}

// NOTE:

なぜこうなったかを示すときに使っています。
使用例は以下です。

function buildShinjiro(content) {
    // NOTE: そういう方なのでこうなってます
    return content + “は” + content 
}

VSCodeだと便利な拡張機能がある

VSCodeの場合、TODOをリスト化してくれる便利な拡張機能があります。
デフォルトではTODO,FIXMEのみの対応ですが簡単に追加可能です。

marketplace.visualstudio.com

アノテーションコメントは今回紹介したもの以外にもあるので、ぜひ活用してみてください。