В Java что такое синтаксис для комментирования нескольких строк?

В Java что такое синтаксис для комментирования нескольких строк?

Я хочу сделать что-то вроде:

(comment)
LINES I WANT COMMENTED
LINES I WANT COMMENTED
LINES I WANT COMMENTED
(/comment)

Ответы

Ответ 1

/* 
LINES I WANT COMMENTED 
LINES I WANT COMMENTED 
LINES I WANT COMMENTED 
*/

Ответ 2

/* 
Lines to be commented
*/

NB: многострочные комментарии вроде этого НЕ ЗАГРУЗЛЯЮТ. Это может быть источником ошибок. Обычно лучше просто прокомментировать каждую строку с //. Большинство IDE позволяют сделать это достаточно просто.

Ответ 3

/*
 *STUFF HERE
 */

или вы можете использовать // в каждой строке.

Ниже приведен так называемый комментарий JavaDoc, который позволяет использовать определенные теги (@return, @param и т.д.) для целей документирования.

   /**
    *COMMENTED OUT STUFF HERE
    *AND HERE
    */

Более подробную информацию о комментариях и соглашениях можно найти здесь.

Ответ 4

Как говорит @kgrad,/* */не гнездится и может вызвать ошибки. Лучший ответ:

// LINE *of code* I WANT COMMENTED 
// LINE *of code* I WANT COMMENTED 
// LINE *of code* I WANT COMMENTED 

В большинстве IDE есть одна команда клавиатуры для выполнения/отмены, поэтому нет причин использовать другой стиль. Например: в eclipse выберите блок текста и нажмите Ctrl +/
Чтобы отменить этот тип комментария, используйте Ctrl +\

UPDATE: Соглашение о кодировании Sun говорит, что этот стиль не должен использоваться для комментариев текстового блока:

// Using the slash-slash
// style of comment as shown
// in this paragraph of non-code text is 
// against the coding convention.

но//можно использовать 3 других способа:

  • Комментарий по отдельной строке
  • Комментарий в конце строки кода
  • Комментирование блока кода

Ответ 5

С /**/:

/*
stuff to comment
*/

Ответ 6

Вы можете использовать /* begin comment и завершите его */

Или вы можете просто использовать//в каждой строке (не рекомендуется)

/*
Here is an article you could of read that tells you all about how to comment
on multiple lines too!:

[http://java.sun.com/docs/codeconv/html/CodeConventions.doc4.html][1]
*/

Ответ 7

  • Простой вопрос к вашему ответу уже много раз ответил:

    /*
    LINES I WANT COMMENTED
    LINES I WANT COMMENTED
    LINES I WANT COMMENTED
    */
    
  • Из вашего вопроса, похоже, вы хотите прокомментировать много кода? Я бы посоветовал использовать репозиторий (git/github) для управления вашими файлами вместо комментирования строк.

  • Моим последним советом было бы узнать о javadoc, если он еще не знаком, потому что документирование вашего кода действительно важно.