Top > コーディング規約 > JavaDoc対応コメント

JavaDoc対応コメント

コーディング規約のお次は、JavaDocを意識した記述です。
ここでは、javadoc コマンドの使い方は説明しませんので、JavaDocって何?
という方は、ネット上で javadoc コマンドの使い方を調べてください。

JavaDocの何を意識するの?

JavaDocには、色々なキーワードを記述することができます。
管理人は、全部のJavaDocキーワードを使いこなす必要はないと思っています。
コーディング上のオーバーヘッドを抑えつつ、効果的なバランスを、経験上から
 以下のキーワードに厳選してみました。

  • @param キーワード
  • @return キーワード
  • @exception キーワード
  • クラス、メソッド、ローカル変数以外の説明
  • @author キーワード

他にも JavaDocには、@で始まるキーワードがありますで、実用上を考えると、
上記ぐらいでよいと思いますので、ソースを記述する際には、きっちりと守るように
しておくと、ソースの読みやすさがぐっと高まると思います。