Javadoc ドキュメンテーションコメントの書き方 - Qiita

出展: プログラム内のコメントの書き方 | 天才まくまくノート はじめに（モチベーション） こんな話があります。あるソフトウェア企業が一人の技術者の採用を決めました。その決め手となった理由は、「公開しているオープンソースソフトウェアのドキュメントが素晴らしかったから」です。彼らは、作成されたドキュメントを見ただけで、その人には技術力がある、一緒に働いて欲しいと判断したのです。 ある国の言語を学ぶために読み書きの練習が必要であるのと同様に、コーディング技術をつけるには、多くの良質なコードを読み、多くのコードを書くことが必要です。設計ドキュメントを書くのも同じことです。日頃から分かりやすいドキュメントを書く鍛錬を怠らず、長年の経験を積んでいかなければ、良質なドキュメントを書く力は身に付きません。今日からドキュメンテーションコメントをバリバリ書いて、ドキュメンテーション力を付けていきましょう。

[r_jimano]

API 実装者のためのコメント（実装方法）と、API 使用者のためのコメント（使用方法）のどちらを書いているのか

[SWIMATH2]

前半はドキュメンテーション一般に応用できそうな話だった。

[naga_sawa]

Javadoc の書き方ガイドライン

[kiyo_hiko]

はい

[yohoojapan]

“ストックストック済み解除”

[adachi_c]

大事

[gologo13]

looks a good guideline to write comments.

[teracy_junk]

心がけたい

[richard_raw]

C++だけどJavadoc風に書いているので参考にします。取り敢えず英語で書こうっと（爆）

[raimon49]

nullをどう扱うか、スレッドセーフか

[foaran]

あとで

[efcl]

Javadocによるコードのドキュメンテーションコメントについてよくまとまってる記事。 なぜ必要か、メソッド、クラス、インターフェース、パッケージそれぞれどのような事を書くべきなのかについてよく書かれている。 コ

[mooz]

素晴らしい記事だ