Как оставлять комментарии в коде?
Очень часто при написании программы необходимо оставить какой-то комментарий. Например:
- "этот блок кода отвечает за ..."
- "эта переменная отвечает за..."
- и т.д.
Поверьте, это очень хорошая практика прописывать комментарии. Благодаря этому:
- Вы всегда легко вспомните что к чему в программе. Стандартная практика - месяц не подходил к коду, открываешь его и сам не веришь, что это ты написал... И вот в этот момент так тепло и радостно на душе, когда видишь комменты...
- И тот, кто после Вас будет работать с Вашим кодом, скажет Вам огромное спасибо. Вас же не будет под боком, чтоб спросить: "А что это ты, друг, имел ввиду...?"
Так что пишите комменты - позаботьтесь о себе и о последующих поколениях...
Итак, как оставлять комментарии? Покажем на примере.
Пример №1
|
1 2 3 4 5 6 7 8 9 10 11 |
/* Программа, демонстрирующая выведение значения переменной на консоль */ class Test { public static void main(String args[]){ int k = 10; System.out.println (k); //выводит на консоль значение переменной k } } |
В примере показано, что, если комментарий написан в 1 строчку, используем две косые черты // и далее пишем наш коммент
|
1 |
System.out.println (k); //выводит на консоль значение переменной k |
Если же комментарий у нас не в 1 строчку, а в 2 и более строк, то используем такую конструкцию для написания комментариев
|
1 2 3 4 |
/* Программа, демонстрирующая выведение значения переменной на консоль */ |
Ну, вот, теперь Вы умеете оставлять комментарии в коде. Миссия статьи выполнена. Напоследок вспомнилось латинское изречение, которое в том числе подходит и к комментариям: "Храни порядок и порядок сохранит тебя".