Подсказка для себя или как закомментировать php-код. урок 3

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

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

Начнем!

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

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

Комментарии в сложном коде и рефакторинг

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

Например, есть метод, который сравнивает числа a и b. Если a > b, он возвращает true, a если a < b — false:

Весь этот громоздкий кусок кода можно значительно упростить, просто убрав блок if-else:

Теперь метод выглядит намного проще и элегантнее, хотя его суть не изменилась. Подобные преобразования называются рефакторингом.

Написание комментариев в Bash

Bash игнорирует все, что написано после хеш-метки ( #) в строке. Единственное исключение из этого правила – первая строка в скрипте начинается с #!символов. Эта последовательность символов называется Shebang и используется, чтобы сообщить операционной системе, какой интерпретатор использовать для анализа остальной части файла.

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

Пробел после хеш-метки не обязателен, но он улучшит читабельность комментария.

Обычно, когда скрипт открывается в текстовом редакторе , комментарии отображаются зеленым цветом.

Комментарии также полезны при тестировании скрипта. Вместо удаления некоторых строк или блоков вы можете закомментировать их:

Краткий ответ

Вы можете «раскомментировать строку» в файле конфигурации, удалив # в начале строки. Или, чтобы «закомментировать» строку, добавьте символ # в начало строки

(Обратите внимание, что некоторые языки имеют разные форматы комментариев, поэтому это может быть не так, если вы работаете с файлом исходного кода.)

Например, допустим, у вас есть файл со следующим текстом:

Чтобы раскомментировать строку, вы должны удалить символ # перед ней так, чтобы текст стал:

Чтобы закомментировать строку, вы должны следовать этому процессу в обратном порядке. Например, этот текст:

Сохраните файл конфигурации после внесения этих изменений.

есть ли какой то вариант проверка вхождения по целой строке? то есть не по концу

Не понял вопроса. И пиши вопрос в теле сообщения, а не в заголовке.

Только перезаписав все содержимое файла с начала.

Добавить в начало строки знак(и) начала построчного комментария, если они в этом языке есть.

С чем из необходимого для этого вы испытываете затруднения: с построчным чтением файла (потока)? со подсчетом или сравнением строк? со сложением строк? с построчным выводом в файл (поток)?

Какое это имеет отношение к вашему словесному вопросу?

Как то так получается что всеравно коментируется 2 строки,что бы я не делал, по логике я коментирую строку в файле,и делаю это примерно так:

Тепло, но это неправильно. Читай что такое регулярные выражения.

• ‘.’ (точка) – принимает любой символ. То есть твоя регулярка заменит вхождение ‘192л168о1л2’
• строке 192.168.1.21 есть подстрока 192.168.1.2, поэтому тоже будет заменен. Подсказка: может тебе надо еще пробельный символ добавить в конец шаблона, или что там у тебя в заменяемом тексте.
• ошибка копипасты: ‘2’ заменяешь ’21’. Посмотри на расширенные рег выражения с группами для замены вхождений групп (sed -r), как метод борьбы с подобными ошибками

Может всё же прочтёшь мануал хоть по чем-нибудь, дебилоид?

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

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

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

Многострочные

Большинство высокоуровневых языков программирования поддерживают многострочные комментарии, которые помогают более подробно описывать детали реализации сложных для понимания блоков кода. Общепринятым синтаксисом для данной конструкции является слеш со звездочкой в начале выделенного блока (/*) и те же самые символы в обратном порядке в конце комментария (*/). Однако Python не поддерживает подобную возможность, вместо нее предлагая использовать совокупность нескольких однострочных комментариев.

# coding: utf-8
# программа Hello World
# создает и выводит строку на экран
# начало программы
greeting = "Hello World!" # создаем строку
print(greeting) # выводим строку на экран
# конец программы

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

Однако современные IDE и редакторы кода, такие как PyCharm или NetBeans способны не только отображать синтаксис языка, но также поддерживают множество горячих клавиш для более быстрого написания программ. С их помощью можно моментально закомментировать огромный блок кода, а также оперативно избавиться от символов решетки в начале каждой строки. Это существенно ускоряет работу программиста и улучшает удобство тестирования.

Так, например, чтобы закомментировать несколько строк Python кода, в PyCharm, следует их выделить и нажать комбинацию клавиш <Ctrl>+</>.

Что такое комментарии и зачем они нужны?

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

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

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

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

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

Как комментируют функции и библиотеки

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

Например, документирующий комментарий из заголовка библиотеки Lodash для JavaScript выглядит так:

Кроме этого, в заголовочных комментариях к функциям указывают стандартный набор сведений:

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

Пример из той же библиотеки Lodash:

Главное здесь — избегать бессмысленных комментариев. Вот пример плохого описания процедуры на языке 1С:

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

Иногда возникает необходимость закомментировать html код. Зачем это может быть необходимо? Чтобы отключить его действие на какое-то время, но не удалять совсем. Это просто удобно, поэтому в этой статье я расскажу о том, как это делается.

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

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

Абзац

Абзац

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

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

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

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

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

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

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

Однострочные

В каждом отдельно взятом языке программирования используется собственный синтаксис однострочных комментариев. Зачастую в роли специального оператора, который сообщает компьютеру о том, что следующая строка является комментарием, задействуется двойной слеш (//). В Python эту функцию выполняет обычный символ решетки (#). Следующий код демонстрирует создание двух однострочных комментариев внутри самой программы.

# this is a comment
# print("Hello World!")

Если запустить программу с этим кодом на выполнение, ничего не произойдет, поскольку, как уже было сказано ранее, комментарии полностью игнорируются компьютером. Писать пояснения можно не только на английском, но и на русском языке. Для русских комментариев в Python нужно подключить кодировку UTF-8 (Unicode Transformation Format, 8-bit). В противном случае, компилятор выдаст ошибку, не сумев правильно распознать символы кириллицы.

# coding: utf-8
# это комментарий

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

# coding: utf-8
# начало программы
print("Hello World!") # выводим приветствие на экран
# конец программы

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

Работая в IDE (Integrated Development Environment), можно увидеть, что комментарии автоматически выделяются курсивом и обладают особой подсветкой, облегчающей их распознавание.

string = "# это не комментарий"

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

string = "text" ####### это комментарий #######

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

CSS 3 псевдо-классы

Вы уже ознакомились со всеми основными селекторами и вам на первых парах этого должно хватить с горкой. Однако в CSS 3 появилось множество новых псевдо-классов, теперь мы можем брать не только первого ребёнка, но и любого другого по счёту, можем идти от обратного, брать не первого, а последнего ребёнка и так далее и тому подобное. Всё это очень удобно и практично, разве что у вас могут возникнуть проблемы со старыми версиями IE. Давайте соберём все силы в кулак и пробежимся по всем оставшимся селекторам, чтобы потом уже вы могли иметь их ввиду при вёрстке собственного макета.

:last-child – аналог :first-child, только берёт не первого, а последнего ребёнка.

:only-child – сработает, если элемент (тег) является единственным ребёнком.

:only-of-type — сработает, если элемент (тег) является единственным ребёнком своего типа.

:nth-child() – обращается к потомкам по их порядковым номерам, можно обращаться ко всем чётным или нечётным (even или odd) числам. Например:

<style>
div p:nth-child(5) {background-color: green;} /* Обращаемся к 5 по счёту ребёнку, если он является тегом p. */
div p:nth-child(2n) {background-color: yellow;} /* Обращаемся к каждому второму ребёнку, если он является тегом p. */
div p:nth-child(2n+6) {background-color: red;} /* Обращаемся к каждому второму ребёнку начиная с шестого, если он является тегом p. */
</style>
<div>
<p>параграф</p>
<p>параграф</p>
<p>параграф</p>
<span>текст в спане</span>
<p>параграф</p>
<p>параграф</p>
<p>параграф</p>
<p>параграф</p>
<p>параграф</p>
<p>параграф</p>
</div>

Результат:

:nth-last-child – работает также как и предыдущий, но отчёт начинается с конца.

:first-of-type – первый ребёнок своего типа в рамках прямого родителя.

:last-of-type – последний ребёнок своего типа в рамках прямого родителя.

:empty – сработает для тех тегов, внутри которых нет ни одного символа (без текста).

:not() – делает исключение для заданных элементов. Пример:

<style>
p:not(.roll) {color: red;} /* для всех параграфов на странице делаем красный цвет текста, за исключением параграфов с классом roll */
</style>
<p class="roll">параграф с классом roll</p>
<p>параграф</p>
<p>параграф</p>
<p class="roll">параграф с классом roll</p>

Результат:

Написание комментариев в скриптах Bash

Еще один способ улучшить читабельность вашего кода – использование комментариев. Комментарий – это понятное человеку объяснение или аннотация, написанная в сценарии оболочки.

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

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

Комментарии обычно используются для объяснения того, что код не может. Например, если у вас есть сложное регулярное выражение или подстановка параметров внутри вашего Bash-скрипта, вы должны написать комментарий о том, что делает код. Комментарии должны быть краткими и точными. Не объясняйте что-то простое и очевидное для читателя.

В этой статье мы рассмотрим основы написания комментариев на Bash.

Старый ответ

Кто вы комментируете?

• Разработчики? Затем прокомментируйте в PHP. Пример:

  Помните, что комментарии HTML отображаются публично. Помещение комментария, например, в примере выше, является подарком для хакера.

• Пользователи? Затем прокомментируйте в HTML. Пример:

  Здесь намерение состоит в том, чтобы рассказать что-то полезное для пользователей, которые, например, сканируют ваш веб-сайт или делают что-то, что манипулирует HTML (единственный допустимый пример, который я видел бы, заключается в том, что выполнение реального API слишком дорого для вас, поэтому вы авторизуете и приглашаете пользователей непосредственно анализировать HTML-код).

Помните, что:

• Комментарии HTML могут быть видны всем,

• HTML-комментарии отправляются клиенту, что увеличивает использование полосы пропускания. Примечание: в большинстве случаев вам все равно; это не несколько дополнительных байтов, которые повлияют на производительность вашего сайта, если вы не работаете на главной странице Google.

20071113

Vim: как закоментировать блок кода

Во многих языках программирования есть синтаксис комментариев, при котором всё начиная с некоторой последовательности символа и до конца строки является комментарием. Чаще это комментирующими символами являются: « # » (скриптовые языки), « // » (C++ и компания) или « ; ». Это довольно удобно, если надо закомментировать строчку. Если же надо так закоментировать несколько подряд идущих строк, то добавление символа комментария в каждую строчку вручную довольно утомительно.

К счастью, в редакторе vim есть возможность сделать это быстро:

1. CTRL-v (для выделения блока текста движением курсора вниз (j) или вверх (k)),
2. затем заглавная I (вставка во все строки блока) и комментирующие символы, которые нужно добавить (например, « // » или « # »), ESC.

И всё, 6+N нажатий на клавиши для комментирования N строк текста

Обратите внимание, что команда блоковой вставки — это заглавная I , а не строчная, как обычно

Удалять можно также быстро: CTRL-v , выделение блока, X . Если символов комментирования два («//», «–») повторяем последнюю команду: . (точка). И всё! Никаких замен.

Пользователям vim под Windows следует использовать CTRL-Q вместо CTRL-V

Как точно не нужно делать

Не используйте семантические теги для украшательств. Для этого есть CSS.

Может показаться, что некоторые теги подходят для того, чтобы сделать страницу покрасивее, подвигать текст или добавить ему интервалов. Но то, что браузер по умолчанию отображает теги как-то, как вам нужно, не значит, что это нужно использовать. Посмотрим на пример.

Здесь сразу несколько ошибок:

1. Тег должен использоваться для выделения в тексте цитат, а не просто случайного выделения текста. Так совпало, что в браузерах этот блок по умолчанию выделен, но это не значит, что нужно его использовать таким образом.
2. Тег тоже использован для визуального «сдвига» текста. Это неверно, потому что этот тег должен быть использован только для обозначения списков, а во-вторых, в тег можно вкладывать только теги и ничего больше.
3. Тег использован, чтобы визуально раздвинуть текст. На самом деле этот тег используется для выделения параграфов.

А любое выделение, сдвиг или иные превращения текста можно выполнить с помощью CSS.

Поэтому используйте семантические теги по назначению.

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

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

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

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

Комментарии в PHP аналогичны комментариям, которые используются в HTML. В синтаксисе PHP комментарий начинаются всегда с особой последовательностью символов и весь текст, который появляется между этих спецсимволов, будет проигнорирован интерпретатором.
В HTML основная цель комментария в том, чтобы служить в качестве примечания разработчикам, которые могут просматривать исходный код вашего сайта. Комментарии РНР отличаются тем, что они не будут отображаться для посетителей. Единственный способ посмотреть PHP комментарии это открыть файл для редактирования. Это делает PHP комментарии полезными только для PHP — программистов.

В случае, если вы забыли или не знали, как делаются комментарии в HTML, то смотрите пример ниже.

Синтаксис php комментариев: однострочный комментарий

Тогда как в html есть только один вид комментариев, в PHP имеется целых два типа. Первый тип, который мы будем обсуждать, это однострочный комментарий. То есть комментарий, который говорит интерпретатору игнорировать все, что происходит на этой линии справа от комментариев. Для использования этого комментария следует применять символы «//» или «#» и весь текст справа будет игнорироваться интерпретатором PHP.

<?php echo «Hello World!»; // This will print out Hello World!
echo «Psst…You can»t see my PHP comments!»; // echo «nothing»;
// echo «My name is Humperdinkle!»;
# echo «I don»t do anything either»;
?>

Результат:

Hello World!
Psst…You can»t see my PHP comments!

Обратите внимание на то, что несколько наших команд echo не были обработаны, потому что мы закомментировали их с помощью специальных символов комментирования. Этот тип комментариев часто используется для быстрой записи о сложном и запутанном коде или чтобы временно удалить строку кода PHP (для отладки)

Синтаксис php комментариев: многострочный комментарий

Как и HTML — комментарии, многострочные комментарии в PHP могут быть использованы для комментирования больших блоков кода или для записи комментов в несколько строк. Многострочные комментарии в PHP начинается с «/*» и заканчиваются «*/». Все, что находится между этими символами, будет игнорироваться.

<?php /* This Echo statement will print out my message to the
the place in which I reside on. In other words, the World. */
echo «Hello World!»;
/* echo «My name is Humperdinkle!»;
echo «No way! My name is Uber PHP Programmer!»;
*/
?>

Результат.

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

Заключение

Комментарии в языке программирования Python используются для создания собственных пояснений к исходному коду программы. Это позволяет улучшить его понимание другими людьми в процессе командной работы над большими проектами. В языке предусмотрены только однострочные комментарии, однако при помощи текстовых блоков можно получить аналог многострочных комментариев. Для создания документации к отдельным функциям, методам, классам и модулям применяются конструкции docstring. Общепринятые правила документирования исходного кода подробно описаны в сборнике рекомендаций PEP 8.

Что в итоге

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

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

И помните, что комментарий — не панацея, он не спасёт плохой код, даже если сделает его понятнее. Сложные и запутанные фрагменты сокращайте и делайте рефакторинг, а комментируйте по минимуму.