kstack-code-comment

コードコメントを書くときの規約。言語を問わず適用する。理由を理解した上で適用すること。

コメントの説明文は日本語で書く

コメント・docstring・JSDoc の説明文は日本語で書く。識別子・ライブラリ名・コード片は原文を保つ。他の SKILL が指定する Arrange / Act / Assert や Step N: の固定表記は維持し、その説明部分を日本語にする。upstream から取り込んだコードのコメントは対象外。

// Bad
// The provider rejects empty requests with 404.
await client.resume({ selected: true });

// Good
// この provider は空のリクエストを 404 で拒否する。
await client.resume({ selected: true });

なぜ: 説明文を日本語に揃えると、コードとコメントの意図を行き来する際に言語を切り替えずに読める。