/ * * и / * в комментариях Java

для Java язык программирования, есть без разницы между двумя. Java есть два типа комментариев: традиционные комментарии (/* ... */) и комментарии в конце строки (// ...). Смотрите Спецификация Языка Java. Так, для языка программирования Java, как /* ... */ и /** ... */ являются экземплярами традиционных комментариев, и они оба обрабатываются точно так же компилятором Java, т. е. они игнорируются (или более правильно: они обрабатываются как пробел).

однако, как программист Java, вы не только используете компилятор Java. Вы используете всю цепочку инструментов, которая включает, например, компилятор, IDE, систему сборки и т. д. И некоторые из этих инструментов интерпретируют вещи иначе, чем компилятор Java. В частности, /** ... */ комментарии интерпретируются инструментом Javadoc, который включен в Java платформа и генерирует документацию. Инструмент Javadoc будет сканировать исходный файл Java и интерпретируйте части между /** ... */ в качестве документации.

это похоже на теги типа FIXME и TODO: если вы включаете комментарий, как // TODO: fix this или // FIXME: do that, большинство IDE выделит такие комментарии, чтобы вы не забыли о них. Но для Java это просто комментарии.

первый-это комментарии Javadoc. Они могут быть обработаны с помощью javadoc инструмент для создания документации API для ваших классов. Второй-это обычный блок комментариев.

читать раздел 3.7 из JLS ну объясните все, что вам нужно знать о комментариях в Java.

есть два вида комментариев:

• /* текст */

традиционный комментарий: весь текст от символов ASCII /* до символов ASCII */ игнорируется (как в C и c++).

• //текст

комментарий в конце строки: весь текст из ASCII символы // до конца строки игнорируются (как в C++).

---

о вашем вопросе,

первый

/**
 *
 */

используется для объявления Технология Javadoc.

Javadoc-это инструмент, который анализирует объявления и документацию комментарии в наборе исходных файлов и создает набор HTML-страниц описание классов, интерфейсов, конструкторов, методов и полей. Вы можно использовать Доклет Javadoc для настройки вывода Javadoc. Доклет-это программа, написанная с помощью API Doclet, который определяет содержимое и формат выходных данных, генерируемых инструментом. Вы можете написать doclet для создания любого вида вывода текстовых файлов, таких как HTML, SGML, XML, RTF и MIF. Oracle предоставляет стандартный Доклет для генерации Документация API в формате HTML. Доклеты также могут быть использованы для выполнения специальные задачи, не связанные с созданием API документация.

для получения дополнительной информации о Doclet относятся к API.

второй, как ясно объясняется в JLS, будет игнорировать весь текст между /* и используется для создания многострочных комментариев.

---

некоторые другие вещи, которые вы, возможно, захотите узнать о комментариях в Java

• комментарии не могут быть вложенными.
• /* and */ не имеют особого значения в комментариях это начинается с //.
• // не имеет специального значения в комментариях, которые начинаются с /* or /**.
• лексическая грамматика подразумевает, что комментарии не встречаются в символьных литералах (§3.10.4) или строковые литералы (§3.10.5).

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

/* this comment /* // /** ends here: */

Я не думаю, что существующие ответы адекватно рассматривали эту часть вопроса:

когда я должен использовать их?

Если вы пишете API, который будет опубликован или повторно использован в вашей организации, вы должны написать исчерпывающие комментарии Javadoc для каждого public класс, метод, и поле, а также protected методы и поля неfinal классы. Javadoc должен охватывать все, что не может быть переданы сигнатура метода, такая как предварительные условия, постусловия, допустимые аргументы, исключения времени выполнения, внутренние вызовы и т. д.

Если вы пишете внутренний API (тот, который используется разными частями одной и той же программы), Javadoc, возможно, менее важен. Но в интересах программистов обслуживания вы все равно должны написать Javadoc для любого метода или поля, где правильное использование или значение не сразу очевидно.

"убийца особенность" Javadoc является то, что это близко интегрирован с Eclipse и другие IDE. Разработчику нужно только навести указатель мыши на идентификатор, чтобы узнать все, что им нужно знать об этом. Постоянное обращение к документации становится второй натурой для опытных Java-разработчиков, что повышает качество их собственного кода. Если ваш API не документирован с помощью Javadoc, опытные разработчики не захотят его использовать.

первый - для Javadoc, который вы определяете в верхней части классов, интерфейсов, методов и т. д. Вы можете использовать Javadoc как имя, предлагающее документировать ваш код о том, что делает класс или какой метод делает и т. д., и генерировать отчет о нем.

второй-это комментарий блока кода. Скажем, например, у вас есть какой-то блок кода, который вы не хотите, чтобы компилятор интерпретировал, тогда вы используете комментарий блока кода.

еще один // это вы используете на уровне инструкции, чтобы указать, что происходит строки кодов должны делать.

есть некоторые другие также как / / TODO, это будет означать, что вы хотите сделать что-то позже на этом месте

//вообще можно использовать, когда у вас есть какое-то временное решение, но вы хотите посетить позже и сделать его лучше.

надеюсь, что это помогает

комментарии в следующем списке кода Java являются серыми символами:

/** 
 * The HelloWorldApp class implements an application that
 * simply displays "Hello World!" to the standard output.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

язык Java поддерживает три типа комментариев:

/* text */

компилятор игнорирует все от /* до */.

/** documentation */

это указывает на комментарий к документации (doc comment, для краткости). Компилятор игнорирует этот вид комментариев, так же как он игнорирует комментарии, которые используют /* и */. Инструмент JDK javadoc использует комментарии doc при подготовке автоматически генерируемой документации.

// text

компилятор игнорирует все от // до конца строки.

теперь о том, когда вы должны использовать их:

использовать // text когда вы хотите прокомментировать одну строку кода.

использовать /* text */ если вы хотите прокомментировать несколько строк кода.

использовать /** documentation */ когда вы хотели бы добавить некоторую информацию о программе, которая может быть использована для автоматического генерация программной документации.

• один комментарий, например: / / comment
• многострочный комментарий, например: / * комментарий */
• javadoc комментарий например: / * * комментарий */

Java поддерживает два типа комментариев:

• /* multiline comment */ : компилятор игнорирует все от /* to */. Комментарий может охватывать несколько строк.

• // single line : компилятор игнорирует все от // до конца строки.

некоторые инструменты, такие как документация используйте специальный многострочный комментарий для своих целей. Например /** doc comment */ Это комментарий к документации, используемый javadoc при подготовке автоматически сгенерированной документации, но для Java это простой многострочный комментарий.