Java/Комментарии
В Java существуют комментарии, они помогают пользователю понимать свой код, или чужой, если конечно их добавить.
class CommentTest public static void main(String[] args) System.out.println("Здравствуйте, я ваша тётя!"); // Здесь пишем комментарий /* Компилятор полностью игнорирует комментарии И что бы я тут не писал вывода на экран не будет */ > >
Здравствуйте, я ваша тётя!
Комментарии могут быть разных видов, например:
// - текст вашего комментария начнётся сразу за чертами и кончится в конце строки.
/* В этом комментарии может быть сколько угодно строк, важно только ставить в конце */, а в начале /* */
Ну если конечно писать в комментариях что-то важное то они действительно помогут (например начинающим):
class SecondCommentTest public static void main(String[] args) System.out.println("Program started."); //Здесь мы выводим на экран надпись Program started. > >
Последний раз редактировалась 18 марта 2021 в 12:38
Языки
Эта страница недоступна на других языках.
- Эта страница в последний раз была отредактирована 18 марта 2021 в 12:38.
- Если не указано иное, содержание доступно по лицензии CC BY-SA 4.0.
- Политика конфиденциальности
- Описание Викиучебника
- Отказ от ответственности
- Кодекс поведения
- Разработчики
- Статистика
- Заявление о куки
- Условия использования
- Настольная версия
Комментарии на Java: однострочные, многострочные, разница между / * * / и / ** * /
Комментарии на любом языке программирования помогают сделать исходный код читаемым, компилятор игнорирует эти комментарии.
Виды
Java поддерживает три типа комментариев –
- Однострочные комментарии – С их помощью вы можете прокомментировать отдельные строки. Компилятор игнорирует все от // до конца строки.
- Многострочные комментарии – Можете прокомментировать несколько строк. Компилятор игнорирует все от / * до * /.
- Документационные комментарии – Инструмент Javadoc JDK использует этот вид при подготовке автоматически сгенерированной документации.
Следующий пример демонстрирует использование всех трех типов комментариев в Java.
/** * @author Tutorialspoint */ public class CommentsExample < /* Following is the main method here, We create a variable named num. And, print its value * */ public static void main(String args[]) < // Declaring a variable named num int num = 1; // Printing the value of the variable num System.out.println("value if the variable num: "+num); >>
Итог
value if the variable num: 1
Однострочный комментарий в Java
Чтобы прокомментировать конкретную строку, просто поместите двойную косую черту (//) перед строкой, как показано ниже.
// Hello this line is commented
Пример
Следующий пример демонстрирует использование однострочных комментариев в Java –
public class CommentsExample < public static void main(String args[]) < //Declaring a variable named num int num = 1; //Printing the value of the variable num System.out.println("value if the variable num: "+num); >>
Итог
value if the variable num: 1
Многострочный комментарий в Java
Многострочные комментарии в Java начинаются с / * и заканчиваются * /. Вы можете комментировать несколько строк, просто поместив их между / * и * /.
/* Hello this is the way to write multi line comments in Java */
Пример
public class CommentsExample < /* Following is the main method here, We create a variable named num. And, print its value * */ public static void main(String args[]) < int num = 1; System.out.println("value if the variable num: "+num); >>
Итог
value if the variable num: 1
Разница между / * * / и / ** * / комментариями в Java
Чтобы разобраться в разнице между / * * / и / ** * / комментариями в Java приведем примеры.
Многострочные комментарии (/ * * /) используются для комментариев в несколько строк в исходном коде.
Пример с / * * /
public class CommentsExample < /* Following is the main method here, We create a variable named num. And, print its value * */ public static void main(String args[]) < //Declaring a variable named num int num = 1; //Printing the value of the variable num System.out.println("value if the variable num: "+num); >>
Итог с / * * /
value if the variable num: 1
Документационный комментарий (/ ** * /) используется для создания документации по исходному коду с помощью инструмента Javadoc.
Пример с / ** * /
/** * @author Tutorialspoint */ public class CommentsExample < public static void main(String args[]) < int num = 1; System.out.println("value if the variable num: "+num); >>
Итог с / ** * /
value if the variable num: 1
Вы можете сгенерировать Java документацию выше класса с помощью команды Javadoc, как –
C:\Sample>javadoc CommentsExample.java
Средняя оценка 4.4 / 5. Количество голосов: 7
Спасибо, помогите другим — напишите комментарий, добавьте информации к статье.
Или поделись статьей
Видим, что вы не нашли ответ на свой вопрос.
Помогите улучшить статью.
Напишите комментарий, что можно добавить к статье, какой информации не хватает.
Java: Комментарии
Практически все языки программирования позволяют оставлять в коде комментарии. Они никак не используются кодом и нужны исключительно для людей: чтобы программист оставлял пометки для себя и для других программистов.
Комментарии в Java бывают трех видов:
-
Однострочные комментарии начинаются с // . После этих двух символов может следовать любой текст, вся строка не будет анализироваться и исполняться. Комментарий может занимать всю строку:
// For Winterfell! Также комментарий может находиться на строке после какого-нибудь кода:
System.out.println("I am the King"); // => For Lannisters! /* * The night is dark and * full of terrors. */ System.out.println("I am the King"); // => I am the King Задание
Создайте однострочный комментарий с текстом: You know nothing, Jon Snow!.
Упражнение не проходит проверку — что делать? ��
Если вы зашли в тупик, то самое время задать вопрос в «Обсуждениях». Как правильно задать вопрос:
- Обязательно приложите вывод тестов, без него практически невозможно понять что не так, даже если вы покажете свой код. Программисты плохо исполняют код в голове, но по полученной ошибке почти всегда понятно, куда смотреть.
В моей среде код работает, а здесь нет ��
Тесты устроены таким образом, что они проверяют решение разными способами и на разных данных. Часто решение работает с одними входными данными, но не работает с другими. Чтобы разобраться с этим моментом, изучите вкладку «Тесты» и внимательно посмотрите на вывод ошибок, в котором есть подсказки.
Мой код отличается от решения учителя ��
Это нормально ��, в программировании одну задачу можно выполнить множеством способов. Если ваш код прошел проверку, то он соответствует условиям задачи.
В редких случаях бывает, что решение подогнано под тесты, но это видно сразу.
Прочитал урок — ничего не понятно ��
Создавать обучающие материалы, понятные для всех без исключения, довольно сложно. Мы очень стараемся, но всегда есть что улучшать. Если вы встретили материал, который вам непонятен, опишите проблему в «Обсуждениях». Идеально, если вы сформулируете непонятные моменты в виде вопросов. Обычно нам нужно несколько дней для внесения правок.
Кстати, вы тоже можете участвовать в улучшении курсов: внизу есть ссылка на исходный код уроков, который можно править прямо из браузера.
Java комментарии — Javadoc
Наибольшая проблема, связанная с документированием кода – поддержка этой документации. Если документация и код разделены, возникают трудности, связанные с необходимостью внесения изменений в соответствующие разделы сопроводительной документации всякий раз при изменении программного кода. Среда разработки предлагает решение – связать код с документацией, поместив всё в один файл.
Java комментарии необходимы для комментирования программы и для составления или оформления документации. Существует специальный синтаксис для оформления документации в виде комментариев и инструмент для выделения этих комментариев в удобную форму. Инструмент называется javadoc. Обрабатывая файл с исходным текстом программы, он выделяет помеченную документацию из комментариев и связывает с именами соответствующих классов или методов. Таким образом, затратив минимум усилий на оформления комментариев, можно получить хорошую документацию к программе.
На выходе javadoc получается HTML файл, который можно просмотреть любым веб-обозревателем. Этот инструмент позволяет создавать и поддерживать файлы с исходным текстом программы и, при необходимости, генерировать сопроводительную документацию. Библиотеки Java обычно документируются именно таким способом, именно поэтому при разработке программ удобно использовать JDK с комментированным для javadoc исходным текстом библиотек вместо JRE, где исходники отсутствуют.
Java имеет три типа комментариев. Первые два типа: //. и /*. */. Третий тип называется комментарием документации. Такой комментарий начинается с последовательности символов /** и заканчивается последовательностью */. Комментарии документации позволяют добавлять в программу информацию о ней самой. С помощью утилиты javadoc (входящей в состав JDK) эту информацию можно извлекать и помещать в НТМL файл.
Утилита javadoc позволяет вставлять HTML тэги и использовать специальные ярлыки (дескрипторы) документирования. НТМL тэги заголовков не используют, чтобы не нарушать стиль файла, сформированного утилитой.
Дескрипторы javadoc, начинающиеся со знака @, называются автономными и должны помещаться с начала строки комментария (лидирующий символ * игнорируется). Дескрипторы, начинающиеся с фигурной скобки, например , называются встроенными и могут применяться внутри описания.
Комментарии документации применяют для документирования классов, интерфейсов, полей (переменных), конструкторов и методов. В каждом случае комментарий должен находиться перед документируемым элементом.
Для документирования переменной можно использовать следующие дескрипторы:
@see, @serial, @serialField, , @deprecated.
Для классов и интерфейсов можно использовать дескрипто ры:
@see, @author, @deprecated, @param, @version.
Методы можно документировать с помощью дескрипторов:
@see, @return, @param, @deprecated, @throws, @serialData, , @ехсерtiоn.
Общая форма комментариев
После начальной комбинации символов /** располагается текст, являющийся главным описанием класса, переменной или метода. Далее можно вставлять различные дескрипторы. Каждый дескриптор @ должен стоять первым в строке. Несколько дескрипторов одного и того же типа необходимо группировать вместе. Встроенные дескрипторы (начинаются с фигурной скобки) можно помещать внутри любого описания.
Утилита javadoc в качестве входных данных принимает файл с исходным кодом программы. Генерирует несколько НТМL файлов, содержащих документацию по этой программе. Информация о каждом классе будет содержаться в отдельном НТМL файле. Кроме того, создается дерево индексов и иерархии. Могут быть сгенерированы и другие НТМL файлы.
В среде Eclipse генерировать документацию можно используя команду меню Project/Generate Javadoc.
Дескрипторы javadoc
@author описание
Документирует автора класса. При вызове утилиты javadoc нужно задать
опцию -author, чтобы включить поле в НТМL документацию.
Позволяет встраивать в комментарий текст (фрагмент кода). Этот текст будет отображаться с помощью шрифта кода без последующей обработки в НТМL.
@deprecated описание
Определяет, что класс, интерфейс или член класса является устаревшим. Рекомендуется включать дескрипторы @see или для того, чтобы информировать программиста о доступных альтернативных вариантах. Может использоваться для документирования переменных, методов и классов.
Определяет путь к корневому каталогу текущей документации.
@exception имя_исключения пояснение
Описывает исключение для данного метода. Здесь имя_исключения указывает полное имя исключения, а пояснение представляет строку, которая описывает, в каких случаях может возникнуть данное исключение. Может использоваться только для документирования методов.
Наследует комментарий от непосредственного суперкласса.
Встраивает ссылку на дополнительную информацию. При отображении текст (если присутствует) используется в качестве имени ссылки.
Встраивает ссылку. Ссылка отображается шрифтом основного текста.
Позволяет встраивать текст в комментарий. Этот текст отображается «как есть» без последующей обработки HTML.
@param имя_параметра пояснение
Документирует параметр для метода или параметр-тип для класса или интерфейса. Может использоваться только для документирования метода, конструктора, обобщенного класса или интерфейса.
@return пояснение
Описывает возвращаемое значение метода.
@see ссылка
@see пакет.класс#элемент текст
Обеспечивает ссылку на дополнительную информацию.
@serial описание
Определяет комментарий для поля, сериализируемого по умолчанию.
@serialData описание
Документирует данные, записанные с помощью методов writeObject и writeExternal.
@serialField имя тип описание
Для класса, реализующего Serializable, дескриптор обеспечивает комментарии для компонента ObjectStreamField. Здесь имя представляет имя поля, тип представляет его тип, а описание – комментарий для данного поля.
@since выпуск
Показывает, что класс или элемент класса был впервые представлены в определенном выпуске. Здесь выпуск представляет строку, в которой указан выпуск или версия, начиная с которого эта особенность стала доступной.
@throws имя_исключения пояснение
Имеет то же назначение, что и дескриптор @exception.
Отображает значение следующей за ним константы, которой должно являться поле static.
Отображает значение определенного поля static.
@version информация
Представляет информацию о версии (как правило, номер). При выполнении утилиты javadoc нужно указать опцию -version, чтобы этот дескриптор включить в НТМL документацию.