comment-code

コードにコメント・ドキュメンテーションコメントを追加・補強する。コードの実装は変更せず、役割の境界・呼び出し元の前提・返値の契約・他所との依存を「その場で読める」形で記述することが目的。

使い方

comment-code <対象ファイルまたはディレクトリ> [--lang <言語>]

引数を省略した場合は git diff HEAD の差分ファイルを対象とする。 --lang を指定するとドキュメンテーションコメントの形式（JSDoc / docstring / rustdoc 等）を優先言語として扱う。指定がない場合は拡張子から自動判定する。

前提条件

• 対象ファイルが読み取り可能な状態であること
• Git リポジトリ内であること（引数省略時に git diff HEAD を使用するため）

フロー