Как оставлять комментарии в коде?

Facebooktwittergoogle_plustumblrFacebooktwittergoogle_plustumblr

Comments Vertex Academy

Очень часто при написании программы необходимо оставить какой-то комментарий. Например:

  • "этот блок кода отвечает за ..."
  • "эта переменная отвечает за..."
  • и т.д.

Поверьте, это очень хорошая практика прописывать комментарии. Благодаря этому:

  • Вы всегда легко вспомните что к чему в программе. Стандартная практика - месяц не подходил к коду, открываешь его и сам не веришь, что это ты написал... И вот в этот момент так тепло и радостно на душе, когда видишь комменты...
  •  И тот, кто после Вас будет работать с Вашим кодом, скажет Вам огромное спасибо. Вас же не будет под боком, чтоб спросить: "А что это ты, друг, имел ввиду...?"

Так что пишите комменты  - позаботьтесь о себе и о последующих поколениях...

Итак, как оставлять комментарии? Покажем на примере.

Пример №1

В примере показано, что, если комментарий написан в 1 строчку, используем две косые черты // и далее пишем наш коммент

Если же комментарий у нас не в 1 строчку, а в 2 и более строк, то используем такую конструкцию для написания комментариев

Ну, вот, теперь Вы умеете оставлять комментарии в коде. Миссия статьи выполнена. Напоследок вспомнилось латинское изречение, которое в том числе подходит и к комментариям ....

храни порядок и порядок сохранит тебя

Facebooktwittergoogle_plustumblrFacebooktwittergoogle_plustumblr

Facebooktwittergoogle_plustumblrFacebooktwittergoogle_plustumblr

Добавить комментарий

Ваш e-mail не будет опубликован.

Самоучители--узнать детальнее--