Как закомментировать на время код html, css или php, js

Скачать для Windows 7

Отступ текста в HTML при помощи margin

Когда вы размещаете текст на сайте он находится в каком-то теге. Это может быть тег блока <div>, тег таблицы <table>, абзаца <p>, секции <section> и так далее.

Мы можем задать отступ для тега в котором находится текст при помощи CSS свойства margin.

Делается это так:

PHP

<div style=”margin-left:20px;”> Текст блока HTML </div>

1 <div style=”margin-left20px;”>ТекстблокаHTML<div>

Здесь мы воспользовались атрибутом style и в нём указали нужное CSS свойство, задав тексту отступ слева 20px. Так же мы можем задать для нашего блока или другого тега класс и потом в отдельном CSS файле дописать для него стили.

HTML:

PHP

<div class=»text-block»> Текст блока </div>

1 <div class=»text-block»>Текстблока<div>

CSS:

PHP

.text-block {
margin-left:20px;
}

1
2
3

.text-block{

margin-left20px;

}

Если вы не создаёте страницу с нуля, а редактируете уже существующую, то можно не задавать новый класс, а определить уже имеющийся класс или идентификатор. Как это сделать показано в этой статье:«Как определить ID и класс элемента на странице?»

При помощи этого свойства мы можем задать разные отступы тексту в HTML:

  • margin-left — расстояние слева
  • margin-right — расстояние справа
  • margin-top — расстояние сверху
  • margin-bottom — расстояние снизу

Так же можно одновременно в одной строке задать одинаковые или разные отступы со всех сторон:

  • margin: 10px; — делаем отступ текста 10px со всех сторон
  • margin: 15px 30px; — задаём отступ срерху и снизу по 15px, а справа и слева по 30px
  • margin: 15px 25px 35px 45px; — отступ сверху 15px, слева – 25px, снизу – 30px, справа – 45px

Вместо пикселей вы так же можете задавать %, em, rem и другие единицы.

Обратите внимание, если вы задаёте верхний или нижний отступ для тега , , — то, скорее всего, он не сработает. Это связано с тем что верхний и нижний margin работает только для блочных элементов HTML, а указанные выше теги являются строчными

Для решения проблемы можно дополнительно задать этому тегу CSS свойство display:inline-block; чтобы к нему применялись свойства одновременно блочного и строчного элемента HTML.

Тег

В HTML закомментировать строки можно и помощью специальной пары тегов — . Он специально включен в синтаксис языка для этой цели, однако большинство популярных браузеров не поддерживают его работу, за исключением Internet Explorer 8.0. Тег полезно использовать в том случае, когда часть информации необходимо скрыть лишь для браузера IE 8.0, 4.0 и более ранних версий, а также в качестве временного решения при разработке. Специфичным здесь является тот момент, что закомментировать часть кода можно только в теле страницы, то есть, внутри тега .

В приведённом ниже примере, при загрузке страницы в указанных браузерах будет выведен белый лист, в других же программах на странице будет написано :

Навигация по статье:

Нестандартный подход

Помимо классических способов, в HTML закомментировать код можно и специфическими методами. Помимо основных языковых структур HTML, в теле страницы часто указываются скриптовые теги и теги таблицы стилей. Внутри каждого из них также существуют свои определения комментариев.

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

При использовании тега скрипта или таблицы стилей, комментарии могут быть как однострочными, так и многострочными. Первые определяются конструкцией «//», которая с момента написания этих символов комментирует всю оставшуюся строку. Для того чтобы скрыть часть кода, следует воспользоваться синтаксическим описанием «/*» для открытия, и «*/» для закрытия комментария. В случае если после символов «/*» не будет прописана конструкция закрытия, то будет закомментирован весь оставшийся HTML-код.

В представленном примере показан способ нестандартного комментирования:

Тег

В HTML закомментировать строки можно и помощью специальной пары тегов — . Он специально включен в синтаксис языка для этой цели, однако большинство популярных браузеров не поддерживают его работу, за исключением Internet Explorer 8.0. Тег полезно использовать в том случае, когда часть информации необходимо скрыть лишь для браузера IE 8.0, 4.0 и более ранних версий, а также в качестве временного решения при разработке. Специфичным здесь является тот момент, что закомментировать часть кода можно только в теле страницы, то есть, внутри тега .

В приведённом ниже примере, при загрузке страницы в указанных браузерах будет выведен белый лист, в других же программах на странице будет написано :

Нестандартный подход

Помимо классических способов, в HTML закомментировать код можно и специфическими методами. Помимо основных языковых структур HTML, в теле страницы часто указываются скриптовые теги и теги таблицы стилей. Внутри каждого из них также существуют свои определения комментариев.

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

При использовании тега скрипта или таблицы стилей, комментарии могут быть как однострочными, так и многострочными. Первые определяются конструкцией «//», которая с момента написания этих символов комментирует всю оставшуюся строку. Для того чтобы скрыть часть кода, следует воспользоваться синтаксическим описанием «/*» для открытия, и «*/» для закрытия комментария. В случае если после символов «/*» не будет прописана конструкция закрытия, то будет закомментирован весь оставшийся HTML-код.

В представленном примере показан способ нестандартного комментирования:

Нестандартный подход

Помимо классических способов, в HTML закомментировать код можно и специфическими методами. Помимо основных языковых структур HTML, в теле страницы часто указываются скриптовые теги и теги таблицы стилей. Внутри каждого из них также существуют свои определения комментариев.

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

При использовании тега скрипта или таблицы стилей, комментарии могут быть как однострочными, так и многострочными. Первые определяются конструкцией «//», которая с момента написания этих символов комментирует всю оставшуюся строку. Для того чтобы скрыть часть кода, следует воспользоваться синтаксическим описанием «/*» для открытия, и «*/» для закрытия комментария. В случае если после символов «/*» не будет прописана конструкция закрытия, то будет закомментирован весь оставшийся HTML-код.

В представленном примере показан способ нестандартного комментирования:

Тег

В HTML закомментировать строки можно и помощью специальной пары тегов — <comment>. Он специально включен в синтаксис языка для этой цели, однако большинство популярных браузеров не поддерживают его работу, за исключением Internet Explorer 8.0. Тег <comment> полезно использовать в том случае, когда часть информации необходимо скрыть лишь для браузера IE 8.0, 4.0 и более ранних версий, а также в качестве временного решения при разработке. Специфичным здесь является тот момент, что закомментировать часть кода можно только в теле страницы, то есть, внутри тега <body>.

В приведённом ниже примере, при загрузке страницы в указанных браузерах будет выведен белый лист, в других же программах на странице будет написано «Это комментарий»:

Комментарии в PHP

Комментарии в PHP могут быть однострочными и многострочными:

1) Однострочные комментарии в PHP создаются с помощью символов: //. Достаточно просто поставить этот символ перед строкой и она будет закомментирована.Такой вариант применятся в том случае, когда комментарий состоит только их одной строки.

2) Для реализации многострочных комментариев используются символы: /* и */. Такой вариант полезен, если комментарий занимает несколько строк.

Таким образом, мы научились делать

Эту статью я начну с того, для чего нужны комментарии. Предположим, что вы разрабатываете модуль со сложной структурой. Или делаете верстку с множеством вложений элементов. В таких случаях некоторые участки кода лучше всего как-то помечать – для этого и существуют комментарии.

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

Комментарии в HTML

При разработке web-страницы иногда необходимо на время скрыть часть кода или сделать пометку для программиста. Для того чтобы не пользоваться дополнительными приложениями, например, перенося часть кода в другой файл, необходимо знать, как закомментировать строку в HTML.

В отличие от большинства языков программирования, HTML не имеет специальной функции или тега для создания однострочного комментария. При необходимости «спрятать» только одну строку или её часть, приходится использовать классический инструментарий языка. Тем не менее, сделать это можно несколькими способами.

Комментировать код в HTML. Что это и зачем нужно…

Всем привет! Мне, как разработчику сайтов, скриптов и плагинов, часто помогают мои закомментированные подсказки в самом коде. Комментировать код нужно в любом случае, или вы пишите код сами, либо пишите его целой командой. Итак, что значит закомментировать код в HTML? – дать ориентир в HTML коде – сделать подсказку – оставить инструкцию – временно отключить части HTML кода (об этом чуть позже).

Значит, цель комментариев в коде – подсказать или напомнить, где и какая часть кода что выполняет. Кстати, комментарии не видны в браузере, а только если посмотреть в исходный код.

Чтобы оставить комментарий в коде, используют тег:

(открываем тег для комментария) –> (закрываем тег для комментария).

Все что находится внутри, это будет комментарий к коду. Смотрим пример:

Теперь, если через год вам нужно будет где-то что-то подправить на сайте, вы долго разбираться не будете, так как умеете комментировать в HTML коде.

Помните, я в самом начале статьи написал: «- временное отключение части HTML кода (об это чуть позже)»?

Так вот, я частенько пользуюсь комментариями, чтобы временно закомментировать какую-то часть кода.

Вот, например, сейчас вам блок для рекламы не нужен, но в будущем вы хотите, чтобы он отображался на сайте. Чтобы не удалять блок и потом снова не тратить время на их восстановление, достаточно просто закомментировать. Смотрим пример, как я закомментировал картинку «heder.png»:

Это все! Всегда комментируйте то, что пишите в коде, так как голова не чемодан – все не уложишь. В нашем случае лучше потратить секунду на написание комментария, чем потом потратить час, чтобы вспомнить, что это вы в коде сделали.

Источник статьи: http://stepkinblog.ru/html-dopolnenie/kommentirovat-kod-v-html-chto-eto-i-zachem-nuzhno.html/

Комментарии в php коде и как закомментировать код. Основы PHP с нуля. Урок №4

Всем привет!
Продолжаем изучать основы PHP с нуля!
В этом уроке я расскажу, что такое комментарий в PHP и на практике попробуем прописать в коде свой комментарий. Но это еще не все. Еще хочу рассказать, как закомментировать код и для чего это вообще нужно делать.

Начнем!

Что такое комментарий в PHPКомментарий в PHP – это подсказка php-разработчика для быстрого ориентирования в коде, а также для правок.

Комментарий в PHP невиден для пользователя, который открыл веб-страницу для просмотра. Даже если пользователь надумается посмотреть исходный код страницы, комментарий все равно виден не будет, так как и весь код php.

Для чего это нужно

Основная цель комментариев — помочь другим разработчикам. При верстке вы можете явно указывать, какая часть кода формирует шапку, а какая — основную часть. Конечно, опытные верстальщики и без этого бы разобрались, но все равно чтение и понимание кода улучшается. А еще комментарии помогают людям, которые плохо понимают html, все-таки хоть немного разобраться в написанном. Вот пример их использования:

Второе возможное применение комментария — сделать неактивным на время какой-то кусок кода, когда не хотелось бы его удалять, но нужно как бы сделать его выполнение неактивным. Кстати, это может помочь выявить различные ошибки в верстке.

Вообще одно их хороших качеств любого веб-разработчика — это умение писать красиво оформленный и понятный код. Это означает, что нужно использовать отступы, показывая вложенность элементов, также при необходимости оставлять комментарии, разделять переносами строк основные части документа и т.д. Все это помогает тем, кто будет в будущем редактировать код, а также самому автору, который не потеряется в своем же творении.

В работе программиста постоянно приходится делать какие-то заметки в виде комментариев, с целью описания части кода или отметок на будущее. Каждый язык имеет свой синтаксис, из-за чего при разработке web-страниц частой проблемой бывает незнание того, как в HTML закомментировать строку или сразу небольшой блок.

Docstring

Для создания документации к различным модулям, классам, функциям и методами в Python широко применяется такой инструмент как docstring. Согласно официальному соглашению PEP 8 (Python Enhancement Proposal), которое содержит в себе комплекс общепринятых норм по написанию кода, в Python docstring необходимо использовать в качестве поясняющей конструкции для всех создаваемых блоков кода. Такие примечания необходимо помещать сразу же после определения класса, метода, функции или модуля, заключая текст в тройные кавычки.

# coding: utf-8
# программа Hello World
def greeting():
    """Функция приветствия.

    Создает и выводит строку на экран.
    """
    greeting = "Hello World!" # создаем строку
    print(greeting) # выводим строку на экран
greeting() # вызываем функцию greeting()
print(greeting.__doc__) # выводим docstring

Данный пример демонстрирует работу функции greeting(), которая создает строку и выдает ее на экран. Здесь применяется конструкция docstring, сообщающая программисту основные сведения о вызываемом методе. В отличие от обычных комментариев, docstring, как правило, обрабатывается компилятором и помещается в полученный байт-код. Во время выполнения программы записанные ранее сведения можно вывести на экран с помощью метода __doc__.

Как закомментировать строку в html

Для этого существует специальный тег — . Весь код, который нужно заккоментировать, вставляют в него. Например, в html есть три абзаца. Один из них вам по каким-то причинам нужно на время убрать, но не удалять из кода.

Вот так вот и применяется данный тег для того, чтобы закомментировать html. Сначала открывается угловая скобка, потом идет восклицательный знак и два дефиса. Далее нужно написать то, что непосредственно превратиться в комментарий.

В нашем случае это код, который создает абзац. Таким образом, браузер проигнорирует этот код, он останется виден лишь в текстовом редакторе, а на веб-страничке вы его не увидите. Комментарий также нужно закрыть двойным дефисом и угловой скобкой.

Закомментировать в html можно сколько угодно строк. Просто закройте тег там, где нужно закончить комментарий. Если вы пользуетесь нормальным редактором кода, то закомментированная часть будет выделяться по-другому. Например, в Notepad++
это выглядит так:

Однострочные комментарии

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

std::cout << «Hello, world!» << std::endl; // всё, что находится справа от двойного слеша, — игнорируется компилятором

1 std::cout<<«Hello,world!»<<std::endl;// всё, что находится справа от двойного слеша, — игнорируется компилятором

Как правило, однострочные комментарии используются для объяснения одной строчки кода:

std::cout << «Hello, world!» << std::endl; // cout и endl находятся в библиотеке iostream
std::cout << «It is so exciting!» << std::endl; // эти комментарии усложняют чтение кода
std::cout << «Yeah!» << std::endl; // особенно, когда строки разной длины

1
2
3

std::cout<<«Hello,world!»<<std::endl;// cout и endl находятся в библиотеке iostream

std::cout<<«It isso exciting!»<<std::endl;// эти комментарии усложняют чтение кода

std::cout<<«Yeah!»<<std::endl;// особенно, когда строки разной длины

Размещая комментарии справа от кода, мы затрудняем себе как чтение кода, так и чтение комментариев. Следовательно, однострочные комментарии лучше размещать над строками кода:

// cout и endl находятся в библиотеке iostream
std::cout << «Hello, world!» << std::endl;

// теперь уже легче читать
std::cout << «It is so exciting!» << std::endl;

// не так ли?
std::cout << «Yeah!» << std::endl;

1
2
3
4
5
6
7
8

// cout и endl находятся в библиотеке iostream

std::cout<<«Hello,world!»<<std::endl;

 
// теперь уже легче читать

std::cout<<«It isso exciting!»<<std::endl;

 
// не так ли?

std::cout<<«Yeah!»<<std::endl;

Составление графика при строительстве: особенности

Календарный график монтажа отдельно взятого объекта (КП) планируется в разделе ППР на стадии создания рабочего пакета документов. Это основная техническая бумага, согласно которой производится руководство, постоянный контроль над ходом строительно-монтажного процесса, контролируется вся работа субподрядных предприятий.

Сроки, установленные в документации, применяются в качестве начальных данных: недельно-суточных планах, сменных различных заданиях.

Исходной информацией при составлении КП выступают:

  • календарный комплексный график в составе ПОС;
  • нормативы периода строительства;
  • рабочие сметы, чертежи;
  • сведения о технических потенциальных возможностях предприятий-участников монтажа;
  • технологические схемы на процессы строительства.

В ходе составления КП разрабатывается номенклатура действий, определяются их объемы. Так же процесс создания производственного графика включает:

  • подбор методов исполнения работ и необходимые средства механизации;
  • определение состава исполнительных бригад и основных звеньев;
  • установка технологическая равномерная последовательность исполнения действий и расчет количества исполнителей, составление сметы;
  • определение длительности рабочих процессов и их взаимосвязь, по необходимости осуществляется корректировка количества исполнителей;
  • разрабатывается план основных потребностей в определенных ресурсах, производится сравнение расчетной продолжительности монтажа с нормативными показателями.

При наличии простых типовых ТК необходимо уточнить их привязку к условиям местности и принять сведения ТК в виде расчетных.

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

Но обратите внимание, что его можно комментировать так, как и код-CSS. …либо так можно закомментировать — однострочный вариант, когда используем НЕ ДВА СЛЕШ, но БЕКАР (решётка) перед комментируемой строкой:

…либо так можно закомментировать — однострочный вариант, когда используем НЕ ДВА СЛЕШ, но БЕКАР (решётка) перед комментируемой строкой:

<?php else:
# get_template_part(«post», «noresults»);
endif;

…Естественно, комментировать нужно осторожно в цикле кода!

…либо же таким образом — аналогично показанному выше примеру для CSS… т.е. этот /* код */
вариант комментирования подойдёт и для CSS и для JS
кодов!

<?php else:
/* get_template_part(«post», «noresults»); */
endif;

А вот таким образом можно закомментировать более объёмное пояснение к коду PHP, где-то меж его основными примерами…

<?php /**
* The default post formatting from the post.php template file will be used.
* If you want to customize the post formatting for your homepage:
*
* — Create a new file: post-homepage.php
* — Copy/Paste the content of post.php to post-homepage.php
* — Edit and customize the post-homepage.php file for your needs.
*
* Learn more about the get_template_part() function: http://codex.wordpress.org/Function_Reference/get_template_part
*/

Ещё в циклах php можно комментровать и так, коли код смешанный… php и как-то html

Аналогично описанному выше:

К примеру какая-то такая функция… где-то в общем коде (или цикл в html): <?php mihalica_add_viva(); ?>
— можно закомментировать, т.е добавить свою метку так:

<?php /** или тут **/ mihalica_add_viva(); /** или так: здесь можно поместить целый цикл какой-то функции — она будет неактивна! **/ ?>

или так: однострочный вариант…

<?php // mihalica_add_viva(); — однострочный (до переноса строки)
/** или так: здесь можно помести целый цикл какой-то добавочной функции —
*…она будет неактивна! **/
?>

Сведения:

php код не виден ни в каких исходных кодах!! виден только его функциональный результат — отработка!

Вот в общем и всё что хотелось нынче доложить!

Теперь можете поэкспериментировать… Удачи.

И конечно же, читайте статьи сайта и подписывайтесь:Делюсь горьким опытом — кое-какими знаниями, для вашего сладкого благополучия))

…город веб мастеров Михалика.ru

— запросто с WordPress

Михаил

2016-05-05
1
HTML и CSS

2

Как писать в html комментарии в коде?

Сегодня я вам расскажу, как делать в html комментарии в коде. Комментарии — это очень полезная вещь. Они никак не влияют на выполнение кода и внешний вид страниц, а еще их не увидеть в исходном коде страницы. По сути, комментарии можно увидеть только открыв файл в редакторе. У меня в Notepad++ они подсвечиваются зеленым цветом.

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

Припустим, вы написали php код, но по каким-то причинам вам нужно удалить из кода 2 строки.
Я не спешу удалять что-то из кода, особенно, если это php-код, я лучше его закомментирую. А вдруг нужно будет код вернуть. Легче же разкомментировать, чем по-новому писать код.

Как закомментировать код в
PHPПример с однострочным комментарием:

!!!»;
// echo «Подпишись на обновление»;
?>

Пример с многострочным комментарием.

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

Вы зашли по адресу… но несколько слов для ясности и пользы дела. Наверняка видели, как это делается с CSS-кодом
, так как сss представляет наибольший интерес у многих начинающих, как и я.

… Хорошо!

Но обратите внимание, что комментарии используются также и в html и php
… А ведь большинство начинающих путаются на начальном этапе своей работе с сайтом и не знают, как дописать себе необходимые пояснения. Ведь бывает же так, например, вам потребуется на какое-то время деактивировать код html
, а потом снова возобновить его функцию — это запросто реализовать, если вы сделали себе пометки на «полях», да мало ли что

Но что следует помнить о «комментариях» вообще — тут всё в строгой зависимости от того, с каким файлом вы работаете конкретно, а следовательно и код применения различен.

Комментарии в HTML

При разработке web-страницы иногда необходимо на время скрыть часть кода или сделать пометку для программиста. Для того чтобы не пользоваться дополнительными приложениями, например, перенося часть кода в другой файл, необходимо знать, как закомментировать строку в HTML.

В отличие от большинства языков программирования, HTML не имеет специальной функции или тега для создания однострочного комментария. При необходимости «спрятать» только одну строку или её часть, приходится использовать классический инструментарий языка. Тем не менее, сделать это можно несколькими способами.

Как закомментировать HTML, PHP, CSS.

Для того, чтобы закомментировать HTML строчки кода, оберните их символами – «
».

Пример:

Закомментировать PHP, можно, используя символы – «/*
и */
».

Пример:

В случае с CSS, применяются те же символы, что и у PHP — «/*
и */
».

Зачем нужны комментарии в html

Чтобы добавить несколько курсоров или множественный выбор в столбце по непрерывным линиям, выполните следующие действия. Когда вы перетаскиваете вертикально, курсоры добавляются в каждую строку, которую вы перетаскиваете. После того, как вы добавили курсоры в нескольких местах, вы можете начать вводить текст.

Если присутствует несколько курсоров, добавляется новый текст. Если вы выбрали контент в нескольких строках текста, выбранный текст будет заменен новым введенным текстом. Чтобы добавить несколько курсоров в разных столбцах в разных столбцах. Выберите несколько строк текста, затем нажмите клавиши со стрелками влево или вправо.

Пример:

/* #optin input {
background: #960e17;
border: 1px solid #111 } */

По возвращению к редактированию Ваших файлов, просто удалите поставленные символы и спокойно занимайтесь новыми разработками.

Возможно, что Вас ещё заинтересует:

Надеюсь, что Вам была полезна информация о том, как закомментировать HTML!

Друзья, в конце поста находиться любопытное видео, советую посмотреть. Небольшая промывка мозга, но над некоторыми вещами стоит задуматься!

Чтобы добавить курсоры к предыдущим или последующим строкам для выбора, сделайте следующее. Чтобы выбрать непрерывные и непрерывные текстовые строки, выполните следующие действия. Вы можете комбинировать эти подходы для выбора как сплошных, так и отдельных текстовых строк в пределах одного выбора.

Вы можете одновременно открыть несколько встроенных редакторов и просмотрщиков документов. Ошибки, обнаруженные во время листинга и предупреждений, перечислены на панели «Вывод». Номер строки отображается красным цветом, чтобы указывать на ошибки в этой строке.

На сегодня это всё. До новых статей.

Хорошие комментарии

Итак, обычно «объясняющие» комментарии – это плохо. Но тогда какой комментарий считается хорошим?

Описывайте архитектуру

Сделайте высокоуровневый обзор компонентов, того, как они взаимодействуют, каков поток управления в различных ситуациях… Если вкратце – обзор кода с высоты птичьего полёта. Существует специальный язык UML для создания диаграмм, разъясняющих архитектуру кода. Его определённо стоит изучить.

Документируйте параметры и использование функций

Есть специальный синтаксис JSDoc для документирования функций: использование, параметры, возвращаемое значение.
Например:

Подобные комментарии позволяют нам понимать назначение функции и правильно её использовать без необходимости заглядывать в код.
Кстати, многие редакторы, такие как WebStorm, прекрасно их распознают для того, чтобы выполнить автодополнение ввода и различные автоматические проверки кода.
Также существуют инструменты, например, JSDoc 3, которые умеют генерировать HTML-документацию из комментариев

Получить больше информации о JSDoc вы можете здесь: http://usejsdoc.org/.

Почему задача решена именно таким способом?

Важно то, что написано. Но то, что не написано, может быть даже более важным, чтобы понимать происходящее

Почему задача решена именно этим способом? Код не даёт ответа.
Если есть несколько способов решить задачу, то почему вы выбрали именно этот? Особенно если ваш способ – не самый очевидный.
Без подобных комментариев возможна следующая ситуация:
Вы (или ваш коллега) открываете написанный некоторое время назад код и видите, что в нём есть, что улучшить.
Вы думаете: «Каким глупым я раньше был и насколько умнее стал сейчас», и переписываете его на «более правильный и оптимальный» вариант.
…Желание переписать код – это хорошо. Но в процессе вы понимаете, что «оптимальное» решение на самом деле не такое уж и оптимальное. Вы даже смутно припоминаете, почему, так как в прошлый раз вы уже его пробовали. Вы возвращаетесь к правильному варианту, потратив время зря.
Комментарии, объясняющие решение, очень важны. Они помогают продолжать разработку в правильном направлении.

В коде есть какие-то тонкости? Где они используются?

Если в коде есть какие-то тонкости и неочевидные вещи, его определённо нужно комментировать.

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

Ваш адрес email не будет опубликован. Обязательные поля помечены *

Adblock
detector