回答:
ドキュメント化のポイントは、アイテムの将来のユーザーを明らかにすることです。これは、部分的には作者の便宜のためです。そのため、誰かが事がどのように機能するかを理解できない場合は、彼または彼女に連絡する必要はありません。しかし、ほとんどの場合、それを使用またはサポートする必要がある人々の利益のためです。
そのため、著者にとっての便宜とは対照的に、ポイントは明快でなければなりません。あなたは本質的に怠惰で自分自身を繰り返すことができなかったので、人々があなたのAPIドキュメントを探し回るのを期待することはできません。それを吸ってください--Javadocは繰り返しになります。
とは言っても、理由はありません。賢いのであれば、マーカーやその他の基準に基づいてコードにコメントを貼り付けるプログラムを作成することはできません。それは価値があるよりももっと面倒かもしれません。か否か。