VSCode コメントアウト関連Tips 4選

ほうき星です。
普段VSCodeでコードを書いていますがコメントアウトに関して最近知った機能があり、
私自身がよく使用している機能も含め備忘録を兼ねて4つ紹介させてもらえればと思います。

ブロックコメント

複数行選択した状態でShift + Alt + A押下で選択した行をすべてブロックコメントで囲うことができます。

javascript

pythonにはブロックコメントがありませんが三連引用符で囲われた文字列になります

折り畳み

#region #endregionで囲むことで任意の場所を折りたたむことができます。
デフォルトで折りたたまれる単位であるクラスや関数等をまとめて折り畳みたい場合等に便利です。

例

#region
def nanikashirano_shori1() -> None:
    pass

def nanikashirano_shori2() -> None:
    pass
#endregion

ミニマップでの強調表示

コメントアウトにMARK:と記述することでミニマップ上の文字列を強調することができます。
ミニマップ上で行方不明になりがちなので目印としてよく記述しています。

例

# MARK: 何かしらの処理1

Todo Tree

VSCode純正の機能ではないのですがTodo Treeという拡張機能を使うことで、コメントアウトに特定のキーワードを付けた際にハイライトと一覧化ができるようになります。

例

# TODO: ちゃんと処理を書く
def nanikashirano_shori1() -> None:
    pass

# FIXME: 要修正
def nanikashirano_shori2() -> None:
    pass

# BUG:
# HACK:
# XXX:
# [ ]:
# [x]:

好みでsettings.jsonを編集することで反応するキーワードを増やすこともできます。

さいごに

この記事が誰かの役に立てば幸いです。