В Java какой синтаксис для комментирования нескольких строк? - PullRequest
15 голосов
/ 15 марта 2010

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

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

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

Ответы [ 7 ]

55 голосов
/ 15 марта 2010
/* 
LINES I WANT COMMENTED 
LINES I WANT COMMENTED 
LINES I WANT COMMENTED 
*/
20 голосов
/ 15 марта 2010
/* 
Lines to be commented
*/

Примечание: многострочные комментарии, подобные этому, НЕ ГНЕЗДАТЬ. Это может быть источником ошибок. Обычно лучше просто комментировать каждую строку с помощью //. Большинство IDE позволяют сделать это довольно просто.

12 голосов
/ 15 марта 2010

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

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

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

ОБНОВЛЕНИЕ: Соглашение о кодировании Sun говорит, что этот стиль не должен использоваться для блока текст комментарии:

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

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

  1. Однострочный комментарий
  2. Комментарий в конце строки кода
  3. Комментирование блока кода
11 голосов
/ 15 марта 2010
/*
 *STUFF HERE
 */

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

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

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

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

5 голосов
/ 15 марта 2010

С /**/:

/*
stuff to comment
*/
4 голосов
/ 15 марта 2010

Вы можете использовать / * начать комментарий и заканчивайте его * /

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

/*
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]
*/
1 голос
/ 15 марта 2010
  • На простой вопрос к вашему ответу уже много раз отвечали:

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

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