Это мелочи. Но нет ничего важнее мелочей!
Из к/ф «Приключения Шерлока Холмса
и доктора Ватсона»
Очень часто в программном коде необходимо оставить комментарий — не- которые пояснения, напоминания или просто текст, предназначенный для
пользователя. Важно отметить, что комментарий предназначен не для компи- лятора, поэтому компилятором он игнорируется. В Java существует три типа комментариев.
1. Однострочный комментарий. Такой комментарий начинается с двойной косой черты (символ //). Все, что находится в строке кода справа от двойной косой черты, компилятором игнорируется.
2. Многострочный комментарий. Такой комментарий начинается последователь- ностью символов /* и заканчивается последовательностью символов */. Все, что находится между символами /* и */, компилятором игнорируется.
3. Многострочный комментарий документационной информации. Начинается последовательностью символов /** и заканчивается последовательностью символов */. Обычно используется для выделения в качестве комментария данных справочного характера.
Не следует недооценивать значения комментариев. Хороший комментарий су- щественно улучшает читабельность программного кода и позволяет избежать многих неприятностей. К сожалению, большинство программистов учатся это- му правилу на своих горьких ошибках.
