Я думаю, что вы немного немного смущены тем, что на самом деле делает JavaDoc.
JavaDoc никак не влияет на вашу программу. JavaDoc - это средство для компиляции информации о вашей программе. Скажем, вы получаете программу и хотите документацию о том, что она делает в удобном удобном формате. Общие компиляторы, такие как eclipse, имеют возможность компилировать html-файл, полный документации, как это показано в документации API Java. https://docs.oracle.com/javase/7/docs/api/ Все это 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); }
будет генерировать страницы, как этот акцент на/** в верхней части, две звездочки означают, что ниже содержит JavaDoc. Большинство IDE, таких как Eclipse, выделяют JavaDoc. Как вы можете видеть, имена параметров являются просто a и b, в некоторых случаях трудно пометить имена параметров тем, что их функция может быть, поэтому он может сэкономить время, чтобы использовать JavaDoc, чтобы дать описание их, вместо этого кто-то прокручивает ваш код, пытаясь понять, что, черт возьми, они делают. Вы создаете руководство для своей программы для его изменения и обновления.
JavaDoc - это в буквальном смысле руководство о том, как все ваши функции, классы, переменные работают в вашей программе.