コメントに関する規約 【Okapi Project】

要約 ソースの可読性を向上させるのはソースのスタイルを統一することばかりではありません。ソースの中にわかりやすいコメントを記述することも可読性の向上に大きくつながります。ここでは JavaDoc 用のコメントを利用することを前提として実際にどのようなコメントをつけていけば適切なのかを詳細に解説していきます。 目次 5.コメントに関する規約 5.1.ヘッダ部のコメント 5.2.クラス（インターフェース）コメント 5.3.メソッドコメント 5.コメントに関する規約 コメントについては基本的には JavaDoc を出力することを考慮して JavaDoc コメントに準拠することを前提とします。以下に詳細なコメントに関する規約をまとめます。 5.1.ヘッダ部のコメント ヘッダ部に記述するコメントは以下の例のようにタイトル、説明、著作権（Copyright）、作成会社名、変更履歴を記述します。このコメ