Откуда javadoc знает, для какого метода нужен каждый комментарий к документации?

Question

В следующем коде:

public class Rectangle {
    private double length;
    private double width;

    /**
     * The setLength method stores a value in the
     * length field.
     * @param len The value to store in length.
     * 
     */

    public void setLength(double len){
        length  = len;
    }

Как javadoc связывает мой комментарий с методом setLength?Это просто потому, что комментарий пришел прямо перед объявлением метода?

Answer 1

Да, это действительно просто потому, что комментарий приходит прямо перед объявлением метода.

Хотя это не указано явно, насколько я вижу, это следует из описания того, как работает инструмент JavaDoc,см. Как писать комментарии к документу для инструмента Javadoc

В частности, раздел о Исходных файлах :

Инструмент Javadoc может генерироватьвыходные данные, исходящие из четырех разных типов «исходных» файлов:

• Файлы исходного кода для классов Java (.java) - они содержат комментарии к классу, интерфейсу, полю, конструктору и методу.
• [...]

и

Комментарий документа написан на HTML и должен предшествовать классу, полю, конструктору илиобъявление метода.