Как закомментировать код в java

The information on this page is for Archive Purposes Only

5 — Comments

Java programs can have two kinds of comments: implementation comments and documentation comments. Implementation comments are those found in C++, which are delimited by /*. */, and //. Documentation comments (known as «doc comments») are Java-only, and are delimited by /**. */. Doc comments can be extracted to HTML files using the javadoc tool.

Implementation comments are meant for commenting out code or for comments about the particular implementation. Doc comments are meant to describe the specification of the code, from an implementation-free perspective. to be read by developers who might not necessarily have the source code at hand.

Comments should be used to give overviews of code and provide additional information that is not readily available in the code itself. Comments should contain only information that is relevant to reading and understanding the program. For example, information about how the corresponding package is built or in what directory it resides should not be included as a comment.

Discussion of nontrivial or nonobvious design decisions is appropriate, but avoid duplicating information that is present in (and clear from) the code. It is too easy for redundant comments to get out of date. In general, avoid any comments that are likely to get out of date as the code evolves.

Note:The frequency of comments sometimes reflects poor quality of code. When you feel compelled to add a comment, consider rewriting the code to make it clearer.

Comments should not be enclosed in large boxes drawn with asterisks or other characters.
Comments should never include special characters such as form-feed and backspace.

5.1 Implementation Comment Formats

Programs can have four styles of implementation comments: block, single-line, trailing, and end-of-line.

5.1.1 Block Comments

Block comments are used to provide descriptions of files, methods, data structures and algorithms. Block comments may be used at the beginning of each file and before each method. They can also be used in other places, such as within methods. Block comments inside a function or method should be indented to the same level as the code they describe.

A block comment should be preceded by a blank line to set it apart from the rest of the code.

5.1.2 Single-Line Comments

Short comments can appear on a single line indented to the level of the code that follows. If a comment can’t be written in a single line, it should follow the block comment format (see section 5.1.1). A single-line comment should be preceded by a blank line. Here’s an example of a single-line comment in Java code (also see «Documentation Comments» on page 9):

5.1.3 Trailing Comments

Very short comments can appear on the same line as the code they describe, but should be shifted far enough to separate them from the statements. If more than one short comment appears in a chunk of code, they should all be indented to the same tab setting.

Here’s an example of a trailing comment in Java code:

5.1.4 End-Of-Line Comments

The // comment delimiter can comment out a complete line or only a partial line. It shouldn’t be used on consecutive multiple lines for text comments; however, it can be used in consecutive multiple lines for commenting out sections of code. Examples of all three styles follow:

5.2 Documentation Comments

Note: See «Java Source File Example» on page 19 for examples of the comment formats described here.

For further details, see «How to Write Doc Comments for Javadoc» which includes information on the doc comment tags (@return, @param, @see): link

Doc comments describe Java classes, interfaces, constructors, methods, and fields. Each doc comment is set inside the comment delimiters /**. */ , with one comment per class, interface, or member. This comment should appear just before the declaration:

Notice that top-level classes and interfaces are not indented, while their members are. The first line of doc comment (/**) for classes and interfaces is not indented; subsequent doc comment lines each have 1 space of indentation (to vertically align the asterisks). Members, including constructors, have 4 spaces for the first doc comment line and 5 spaces thereafter.

If you need to give information about a class, interface, variable, or method that isn’t appropriate for documentation, use an implementation block comment (see section 5.1.1) or single-line (see section 5.1.2) comment immediately after the declaration. For example, details about the implementation of a class should go in in such an implementation block comment following the class statement, not in the class doc comment.

Doc comments should not be positioned inside a method or constructor definition block, because Java associates documentation comments with the first declaration after the comment.

Комментарии: три способа документировать Java код

Предположим, вы работаете в ИТ-отделе крупной компании. Ваш босс инструктирует вас, что надо написать программу, состоящую из нескольких тысяч строк исходного кода. Через несколько недель вы закончите программу и запустите проект. Через несколько месяцев пользователи начинают замечать, что программа иногда падает. Они жалуются вашему боссу, а он, в свою очередь, приказывает вам: необходимо исправить это. Поискав в вашем архиве проектов, вы находите папку с текстовыми файлами — исходный код программы. К сожалению, вы обнаруживаете, что исходный код не имеет смысла – он просто-напросто вам непонятен. За прошедшее время вы работали в других проектах, и вы не можете вспомнить, почему вы написали код именно так. Расшифровка кода может занять несколько часов или даже дней, но боссу нужен результат еще вчера. Неизбежен немалый стресс. Как же не допустить этого?

Данного стресса можно избежать, если документировать исходный код значимыми описаниями. И хотя это часто упускается из виду, но документирование исходного кода при написании логики программы — это одна из наиболее важных задач разработчика. Как можно увидеть из моего примера, учитывая некоторое время, которое прошло со времени написания кода, даже прекрасный программист может не понять обоснование некоторых решений – почему он сделал именно так, а не иначе.

Читать:

Changzhi2 что это за папка

В Java вы можете использовать функции комментариев: вставлять документацию в исходный код. Комментарий с разделителями – это текст, который имеет смысл для человека, но не для компилятора. При компиляции исходного кода компилятор Java игнорирует все комментарии; он не генерирует байт-код для них. Java поддерживает однострочные, многострочные, и комментарии Javadoc. Давайте посмотрим на примеры для каждого из них.

Однострочные комментарии

Однострочный комментарий охватывает одну строку. Он начинается с // и продолжается до конца текущей строки. Компилятор игнорирует все символы из // до конца этой линии. Следующий пример представляет однострочный комментарий:

Однострочный комментарий полезен для определения короткого значимого описания данной строки кода.

Многострочные комментарии

Многострочный комментарий охватывает несколько строк. Он начинается с /* и заканчивается */ . Все символы из /* через */ игнорируются компилятором. Следующий пример представляет многострочный комментарий:

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

Еще одно применение многострочных комментариев — комментирование блоков кода, которые не требуются в настоящий момент в программе, но, возможно понадобятся в будущем. Они остаются закомментированными, чтобы потом раскомментировать и использовать в любой момент. Следующий исходный код демонстрирует такой сценарий:

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

Комментарии Javadoc

Комментарий Javadoc — это специальный многострочный комментарий. Он начинается с /** и заканчивается */ . Все символы из /** через */ игнорируются компилятором. Следующий пример представляет комментарий Javadoc:

Этот пример в комментарий Javadoc описывает метод main(). Находящееся между /** и */ является описанием метода и @param тег Javadoc ( @ -prefixed инструкции к javadoc инструмента).

Рассмотрим часто используемые теги Javadoc:

@author идентифицирует автора исходного кода.
@deprecated идентифицирует исходный код субъекта (например, метод), который больше не будет использоваться.
@param определяет один из параметров метода.
@see — ссылка.
@since идентифицирует версию программного обеспечения.
@return определяет тип значения, возвращаемого методом.
@throws – выбрасываемые методом исключения.

Хотя комментарии Javadoc игнорируются компилятором, но обрабатываются javadoc , который собирает их в HTML на основе документации. Например, следующая команда создает документацию для гипотетического Checkers класса:

Генерируемая документация включает в себя индексный файл ( index.html ), который представляет собой стартовую страницу. Например, на рисунке ниже вы можете видеть стартовую страницу из документации Java SE 8 update 45 библиотеки API, сгенерированную Javadoc.

Данная статья представляет собой перевод с английского. Автор исходного текста Джефф Фризен, переводчик Юрий Пахолков. Если вам необходим качественный перевод с английского языка (включая специфические тексты по ИТ-тематике), то вы можете обратиться к нам: пишите на электронную почту up777up@yandex.ru с темой «перевод». Мы с удовольствием и за очень небольшую сумму в отечественной или иностранной валюте вам поможем.

Автор этого материала — я — Пахолков Юрий. Я оказываю услуги по написанию программ на языках Java, C++, C# (а также консультирую по ним) и созданию сайтов. Работаю с сайтами на CMS OpenCart, WordPress, ModX и самописными. Кроме этого, работаю напрямую с JavaScript, PHP, CSS, HTML — то есть могу доработать ваш сайт или помочь с веб-программированием. Пишите сюда.

теги статьи IT, java, комментарии, документация

Комментарии в intelliJ IDEA

Комбинация клавиш ctrl+shift+/ закомментирует выделенную часть кода в блок /* */. Комбинация клавиш ctrl+/ закомментирует все выделенные строки путем добавления в начало каждой строки //.

CTRL+ / — Комментирование строки с помощью //.

CTRL + SHIFT + / — Комментирование выделенного блока кода с помощью /**/

Повторное использование этих комбинаций убирает комментарии.

Нажимая «Принять все файлы cookie» вы соглашаетесь, что Stack Exchange может хранить файлы cookie на вашем устройстве и раскрывать информацию в соответствии с нашей Политикой в отношении файлов cookie.

Комментарии на Java: однострочные, многострочные, разница между / * * / и / ** * /

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

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

Однострочные комментарии – С их помощью вы можете прокомментировать отдельные строки. Компилятор игнорирует все от // до конца строки.
Многострочные комментарии – Можете прокомментировать несколько строк. Компилятор игнорирует все от / * до * /.
Документационные комментарии – Инструмент Javadoc JDK использует этот вид при подготовке автоматически сгенерированной документации.

Следующий пример демонстрирует использование всех трех типов комментариев в Java.

Однострочный комментарий в Java

Чтобы прокомментировать конкретную строку, просто поместите двойную косую черту (//) перед строкой, как показано ниже.

Пример

Следующий пример демонстрирует использование однострочных комментариев в Java –

Многострочный комментарий в Java

Многострочные комментарии в Java начинаются с / * и заканчиваются * /. Вы можете комментировать несколько строк, просто поместив их между / * и * /.

Пример

Разница между / * * / и / ** * / комментариями в Java

Чтобы разобраться в разнице между / * * / и / ** * / комментариями в Java приведем примеры.

Многострочные комментарии (/ * * /) используются для комментариев в несколько строк в исходном коде.

Пример с / * * /

Итог с / * * /

Документационный комментарий (/ ** * /) используется для создания документации по исходному коду с помощью инструмента Javadoc.

Пример с / ** * /

Итог с / ** * /

Вы можете сгенерировать Java документацию выше класса с помощью команды Javadoc, как –

Средняя оценка 4.3 / 5. Количество голосов: 6

Спасибо, помогите другим — напишите комментарий, добавьте информации к статье.

Или поделись статьей

Видим, что вы не нашли ответ на свой вопрос.

Помогите улучшить статью.

Напишите комментарий, что можно добавить к статье, какой информации не хватает.

Как закомментировать код в java