プログラムの外で既にドキュメント化されている情報は、プログラム内のコメントに記述しないこと
Web だとよくあるので、これは意識していきたいradish-miyazaki.icon
代わりに、外部のドキュメントへの参照を記述する
e.g. HTTP プロトコルを実装するクラス
コード内で HTTP プロトコルを説明する必要はない
代わりに、HTTP プロトコルを説明する URL を記載する
e.g. ユーザマニュアルで既にドキュメント化されている機能
e.g. 各コマンドを実装するメソッドが1つずつ存在するプログラムの作成
これらのコマンドを説明するユーザマニュアルがある場合、その情報をコード内で複製する必要はない
代わりに、各コマンドメソッドのインタフェースコメントに以下のような文言を追加する
code:java
// 詳細はユーザマニュアルを参照のこと