javadoc

各種資料

(1) 公式（たぶん）

• javadoc | Oracle

(2) 個人的にわかりやすいと思った資料

• Javadoc ドキュメンテーションコメントの書き方 | Qiita
• Java入門ガイド | アイオステクノロジー株式会社

(3) 実際のソースコードでの使用例
①AWS SDK
AmazonS3URI.java
②google-cloud-java
GcsDestination.java
→ それぞれ上の階層をたどると色々と出てくる

(4) Visual Studio Code で Javadoc を書く時のコマンド | ホットドッグヴィレッジ
→ VS Codeでもデフォルトでいけるっぽい
→→ 実際やってみたところ、特別なプラグインなしで書けた

※Javadoc Toolsは、使ってみたところ、少なくともコメントに関して全部にチェックを入れても、うちひとつにしかコメントが入らなかったため、いったん却下（2023/12/07現在）

実用面に即した書き方について考えてみる

あまり情報を盛り込みすぎると、ごちゃごちゃして返って見づらくなる＆メンテがたいへんになる（特に@authorや@version）ので、以下の情報があれば十分かと

• ファイル: 最低限の著作権情報
• クラス: クラス概要
• メソッド: メソッド概要、@param,@return, @throws