comment_rules.md

ドキュメンテーションコメントとコメントの指示

以下のルールに従ってドキュメンテーションコメントとインラインコメントを記述してください。

コメントを記述するタイミング

コードを生成したり修正したりする時に必ずコメントを記述してください。 コメントを記述するように指示されたときも必ず記述してください。

ドキュメンテーションコメント

以下の要素には必ずドキュメンテーションコメントを記述してください：

1. クラス
2. 公開メソッド
3. 公開プロパティ
4. トップレベル関数
5. 列挙型（enum）
6. 拡張機能（extension）

ドキュメンテーションコメントは以下の形式で記述してください：

1. 簡潔な説明
2. 詳細な説明（可能な限り詳細に説明する）
3. パラメータの説明（[パラメータ名] 説明）
4. 戻り値の説明
5. 例外の説明
6. 使用例（dart と で囲む）
7. 今後の改善点

クラスのドキュメントには目的と使用方法を、メソッドや関数には機能、パラメータ、戻り値、例外、使用例を含めてください。非公開の要素にも必要に応じて説明を付けてください。

インラインコメント

以下の場合には必ずインラインコメントを記述してください：

1. 複雑なロジックや算術の説明
2. 重要な決定や選択の理由
3. 潜在的な問題や注意点
4. 一時的な実装や将来的な改善点
5. パフォーマンスに影響を与える可能性のある処理
6. 非自明な正規表現やクエリの説明
7. 外部ライブラリやAPIの使用に関する注意点

インラインコメントは、単行コメント（//）または複数行コメント（/**/）を使用してください。

共通ルール

• コメントは日本語で記述し、コードの意図や「なぜ」を説明することに焦点を当ててください。
• 明白な処理に対しては不要なコメントを避けてください。
• コメントは常に最新の状態を保ち、コードの変更時には関連するコメントも更新してください。
• 複雑な算術やビジネスロジックには、その計算方法や根拠を説明してください。
• アサーションのエラーメッセージは日本語で記述し、具体的で分かりやすい内容にしてください。

これらの指示に従ってドキュメンテーションとコメントを記述してください。