2

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

kak-kommentirovat-kod

Здравствуйте, друзья. Сегодня рассмотрим как комментировать код в HTML, PHP, «.htaccess», CSS. Закомментировать определенный фрагмент кода — это значит прописать подсказку (напоминание) для веб мастера, чтобы быстро  найти и разобрать необходимый  раздел кода. Обычный посетитель сайта комментарии кода не видит.

Давайте рассмотрим подробней на примерах как закомментировать кодировку для  различных языков программирования:

Внимание.  Для каждого отдельного вида языка программирования, существуют определенные правила написания комментариев в коде. Если их не соблюдать, код может перестать работать.

Комментируем в коде HTML:

<! — — Ваш комментарий к коду HTML — — >

Например.

<html>
<head>
<title> КомментариЙ кода HTML </title>
</head>
<body>
<!-- Шапка сайта -->
<img src="shapka kartinka.png">
<!-- конец шапки сайта -->
</body>
</html>

 

Комментируем код PHP:

Для этого кода существует три вида оставления заметок. Можете использовать любой из нижеперечисленных.

/* 1. комментарий в несколько строк */

// 2. комментарий в одну строку для PHP

# 3. Комментарий в одну строку

Например.

<?php get_header();
/*
Template Name: Без боковой колонки
*/
?>

 

Комментируем код в CSS:

/* Ваш комментарий в css */

Пример.

/*----------------------------------------------------------*/
/* Footer
/*----------------------------------------------------------*/
.site-footer {
width: 100%;
}

 

Комментируем код JavaScript.

// комментарий в одну строку

/* коментарий в несколько строк */

Пример.

{
var o = $.extend({
delay: 500, // задержка между появлением элементов
speed: 500, // скорость анимации
ease: 'swing' // функция перехода (другие требуют подключения специального плагина)
}

 

Комментируем в коде «.htaccess»:

# Описание, разъяснение

Пример.

# допуск к админке сайта
define ('FORCE_SSL_ADMIN', false);

Вот так просто можно поставить поясняющие комментарии в коде вашего ресурса. Если понравилась статья, жду ваших отзывов. Всем удачи!

комментария 2
  1. admin
    22.01.2017 в 01:31

    Да Степан, комментирование кода необходимо вам или веб мастеру для того чтобы можно было быстро найти необходимый участок. Комментарии к коду не видны обычному пользователю ресурса. Можете спокойно применять и содержать свой код в порядке. Удачи!

  2. Степан
    21.01.2017 в 20:58

    Очень полезная штука, которая рано или поздно понадобится любому вебмастеру! Мне часто приходится делать правки HTML кода, и если не комментировать код то можно легко запутаться, если конечно вы не профессионал, а такой же любитель как я! Статья очень полезная, я возьму ваши примеры использования для комментирования кода себе на заметку. Я уже их переписал и занес в блокнотик полезных мелочей! Я так понял что они не будут видны на сайте, а только мне когда откроешь файл для внесения изменений?

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

Этот сайт использует Akismet для борьбы со спамом. Узнайте, как обрабатываются ваши данные комментариев.