Коментарі

Коментар - це частина файлу, який не обробляється браузером.

У коментарях може знаходитися пояснення до коду або частина коду, яка з певних причин не повинна виконатися.

Приклади коментарів HTML (jsFiddle):


				<!-- Блок користувача, відображається тільки коли користувач залогінився -->

				<div class="user">

				  ...


				<p>1</p>

				<p>2<!-- коментар всередині тега --></p>

				<!--<p>3</p>-->

				<p>4</p>


				<!-- Приклад неправильного коментаря: -->

				<div <!-- class="test" -->>test</div>

Приклад коментарів CSS:


				/* стилі тексту */

				.text1 { color: red; /*font-style: italic;*/ }

				/*.text2 { color: yellow; }*/

				.text3 { color: blue; }

				.text4 { color: green; font-style: italic; }

				/*.text5 { color: pink; }

				.text6 { color: aqua; }

				.text7 { color: violet; }*/

Чи потрібно коментувати код, пояснюючи що робить той чи інший блок?

Я зустрічав доволі фанатичних розробників, в їхньому коді пояснень більше, ніж самого коду.

В коді варто залишати:

коментарі, які відповідають на питання "чому?", а не "що?", такі коментарі пояснюють незрозумілі ділянки коду, а не просто описують код;
коментарі перед великими блоками коду, в яких в декількох словах пояснюється що робить даний шмат коду. Це полегшує читання і навігацію по коду;
коментарі, що описують закоментовані шматки коду: чому цей шматок коду закоментований і коли слід безповоротно видалити цей шматок коду.