Чем должен отличаться JavaDoc для метода Class и Main? ⇐ JAVA
-
Anonymous
Чем должен отличаться JavaDoc для метода Class и Main?
Простой пример:
Предположим, у меня есть класс, который содержит метод minValue, метод maxValue и метод averageValue, каждый из которых принимает двойной массив, а также метод Main.
Предположим, что в основном методе я определяю двойной массив, а затем печатаю его минимальное, максимальное и среднее значения, используя вышеуказанные методы.
Какой должна быть Javadoc для метода Class и Main?
Я новичок в Java, и мне всегда кажется, что основной метод Javadoc просто повторяет класс Javadoc, и кажется бессмысленным указывать это.
Например
/**Этот класс можно использовать для поиска минимального, максимального и среднего значения массива. Основной метод: вычисляет минимальное, максимальное и среднее значение массива*/ Правильно ли это, или есть лучший способ отличить класс и основной метод Javadoc?
Простой пример:
Предположим, у меня есть класс, который содержит метод minValue, метод maxValue и метод averageValue, каждый из которых принимает двойной массив, а также метод Main.
Предположим, что в основном методе я определяю двойной массив, а затем печатаю его минимальное, максимальное и среднее значения, используя вышеуказанные методы.
Какой должна быть Javadoc для метода Class и Main?
Я новичок в Java, и мне всегда кажется, что основной метод Javadoc просто повторяет класс Javadoc, и кажется бессмысленным указывать это.
Например
/**Этот класс можно использовать для поиска минимального, максимального и среднего значения массива. Основной метод: вычисляет минимальное, максимальное и среднее значение массива*/ Правильно ли это, или есть лучший способ отличить класс и основной метод Javadoc?
