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

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

В (x)HTML комментарии выглядят так: <!– текст комментария –>

В CSS комментарии выглядят так: /* текст комментария */

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

В Ruby комментарии могут быть:
- однострочными # текст комментария
- многострочными
= В случае комментарии размещены
на нескольких строках, = = начинаются и конец должен быть
в начале строки без отступа.
=.

Комментарии полезны не только для собственных заметок, но и на этапе тестинга и «метода проб и ошибок». Чтобы часть кода или правил не использовались, достаточно их закомментить (поверьте опыту – это лучше чем удалять ).

Избегайте использования кириллических символов в комментариях.