Философия Java

         

Комментарии и встроенная документация


Есть два типа комментариев в Java. Первый - традиционный комментарий в стиле C, который был унаследован из C++. Этот комментарий начинается с /* и распространяется на много линий, пока не встретится */. Обратите внимание, что многие программисты начинают каждую линию продолжающихся комментариев с *, так что вы часто можете видеть:

/* Это комментарий, * который распространяется * на несколько строк */

Однако помните, что все внутри /* и */ игнорируется, так что это ничем не отличается от:

/* Это комментарий, который распространяется на несколько строк */

Вторая форма комментариев пришла из C++. Это однострочный комментарий, который начинается с // и продолжается до конца линии. Этот тип комментариев удобен и часто используется из-за своей простоты. Вам нет необходимости охотиться за ключевыми словами, чтобы найти /, а затем * (вместо этого вы нажимаете эту кнопку дважды), и вам нет необходимости закрывать комментарий. Так что вы часто будете видеть:

// Это однострочный комментарий



Содержание раздела