Встроенные комментарии на Java: / ** в отличие от / *?

Question

есть причина, по которой я бы предпочел писать inline-комментарии в Java следующим образом:

/** Init operation */
mindControlLaser.engage();

вместо использования только одного *:

/* i'm a happy comment */

Затмение окрашивает синтаксисиначе, но есть ли что-нибудь в «наборе инструментов» (javadoc, eclipse и т. д.), дающее мне преимущество при использовании / ** * /?

Answer 1

Нет причин для встроенных комментариев.

/** сигнализирует утилите javadoc для автоматического извлечения документации о вашем API.Это не имеет никакого эффекта, когда используется внутри методов.

Answer 2

Регулярные комментарии

/* Regular comment */

С помощью регулярных комментариев вы объясняете, возможно, часть хитрого алгоритма. Или что-то, что вы не хотите быть частью JavaDOC. Встроенные комментарии тоже являются обычными комментариями и могут использоваться, например, когда описание короче.

Документация Java

/** JAVA DOC COMMENT */

С помощью javadoc вы объясняете классы, методы или поля (переменные).

Тогда большинство IDE, таких как Eclipse, могут использовать эту информацию, чтобы помочь вам во время кодирования. Например, если у вас есть classA и classB, а в classB вы используете вещи из classA, то, если вы наводите курсор на методы или переменные, вы можете увидеть информацию JavaDOC. Это очень удобно.

Кроме того, с помощью таких инструментов сборки, как ant, вы можете автоматически создавать HTML-файлы из JavaDOC, а если вы публикуете их, вы можете позволить другим повторно использовать вашу работу. Посмотрите, например, документацию самой Java здесь .

Answer 3

/** .... */ будет генерировать Javadoc, /* ... */ не будет.

Конечно, он будет генерировать Javadoc только в правильных местах . Javadoc также имеет довольно четко определенный формат, см. здесь .

Answer 4

Синтаксис комментария: /* */.

В Javadoc по умолчанию используется /** */.Это комментарий, потому что второй * находится внутри комментария, поэтому ваш компилятор не увидит по-другому.

Так что без второго * вы просто добавляете комментарий, а со вторым вы пишете javadoc: eclipse распознает его и даст вам подсказки и т. Д. При наведении на вызов функции в другом месте.

Answer 5

Javadoc трактует / ** по-разному;классы и методы с / ** комментариями над ними будут помещены в вывод javadoc.

Answer 6

/** обозначает комментарии к документации; Javadocs и т. Д. Ищут их при создании документации для вашего кода.

Таким образом, они действительно должны использоваться только над методами и классами, например ::1004

/**
 * Class to represent tigers.
 */
class Tiger {
    /**
     * Go extinct.
     */
    void goExtinct() {
    }
}

Вариант /* обозначает только стандартный блок комментариев.

Answer 7

Да, это нотация Javadoc для использования /** Primary sentence. Other descriptions... */.Первое предложение до . будет использоваться в сводках javadoc, а остальные в подробном представлении.