Как называются строки документации в Java? - PullRequest
14 голосов
/ 16 сентября 2010

Перед методами Java у нас есть что-то вроде:

/**
 * Takes a number and returns its square root.
 * @param x The value to square.
 * @return The square root of the given number.
 */
public float getSqrt(float x) {
...
}

Есть ли у него имя (например, строки документации в Python)?

Ответы [ 2 ]

15 голосов
/ 16 сентября 2010

На самом деле они называются комментарии к документу , а javadoc - это инструмент для создания этих комментариев в HTML.

Вы можете найти структуру комментария Javadoc Википедия (например).

6 голосов
/ 16 сентября 2010

Да, это называется javadoc .

...