私はあなたが少しJavaDocが実際に何をしているのか混乱しているかもしれないと思います。
JavaDocはあなたのプログラムに直接影響を与えません。 JavaDocは、プログラムに関する情報をコンパイルする手段です。あなたはプログラムを手に入れて、それが便利な形式で何をしているのかを記録したいとします。 eclipseのような一般的なコンパイラでは、Java APIのドキュメントに書かれているように、ドキュメントが満載のhtmlファイルをコンパイルするオプションがあります。 これはすべてJavaDocで、コメントから生成されます。
私の先生方はいつもコメントに関して教えてくれるので、コードを読まない人にはコメントしていません。あなたのようなコメントは必要ありません....
// Prints out hello world
System.out.println("hello world");
プログラマーは、この機能を既に知っています。プログラマーは、パラメータ名や関数が実際に何をするかに関心があります。例
/**
* @param a Number we are dividing into
* @param b Number we are dividing by
* @return Our quotient
*/
public static float divide(int a, int b) {
return (a/b); }
は/ **上部に、2つのアスタリスクは、以下のJavaDocが含まれていることを示すには、この
強調のようなページを生成します。 EclipseのようなほとんどのIDEはJavaDocを強調します。
パラメータの名前は単なるaとbです。パラメータ名を関数の名前でラベル付けすることは難しいため、代わりにJavaDocを使用してパラメータ名の説明を与える時間を節約することができます誰かがあなたのコードをスクロールして、彼らが何をしているのか理解しようとしています。プログラムを修正して更新するためのガイドを作成しています。
JavaDocは、関数内のすべてのクラス、変数がプログラムでどのように機能するかを文字通りのガイドにしています。