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

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

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

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

7 ответов


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

/* 
Lines to be commented
*/

NB: многострочные комментарии, подобные этому, не гнездятся. Это может быть источником ошибок. Обычно лучше просто комментировать каждую строку с помощью//. Большинство IDE позволяют сделать это довольно просто.


/*
 *STUFF HERE
 */

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

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

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

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


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

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

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

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

// 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. комментируя блок кода

С /**/:

/*
stuff to 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]
*/

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

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

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