MnogoBlog
Как создать сайт на wordpress, настроить и оптимизировать wordpress
Как закомментировать код в WordPress для PHP, HTML и CSS
MnogoBlog > WordPress > Дизайн > CSS и теги > Как закомментировать код в WordPress для PHP, HTML и CSS
Как оставить, добавить комментарий в коде на PHP, HTML и CSS.
Для чего нужно оставлять комментарии в коде?
Во-первых, чтобы не забыть для чего этот код нужен и чтобы другие программисты могли понять написанный вами код.
Во-вторых, временно сделать часть кода нерабочим, так как закомментированный код не исполняется, не рассматривается в качестве основного исходного кода.
В-третьих, написанный код с грамотно расставленными комментариями – это отличительны признак профессионального программиста.
Скачать исходники для статьи можно ниже
Закомментированный код в HTML файлах:
Закомментированный код в CSS файлах:
/* .redblock */
Закомментированный код в PHP файлах:
Так как wordpress состоит в основном из php файлов, то скорее всего вам понадобятся следующие структуры кода:
Изучаем комментарии в PHP
Комментарии в PHP при выполнении скрипта игнорируются препроцессором, и нужны только для людей. Разработчики часто пренебрегают комментированием кода.
Среди программистов бытует мнение, что они вспомнят, как работает код, и через шесть месяцев и через год. Еще одна причина не оставлять комментарии — уверенность в том, что код настолько хорошо написан, что он ясен и без пояснений. Но нужно помнить, что может потребоваться продолжать поддерживать созданные скрипты PHP долгое время после написания.
Не менее важная причина комментирования кода — убедиться, что последователи поддерживают или добавляют функциональность вашему творению. Они также получат пользу от чтения оставленных комментариев.
PHP предоставляет два способа комментирования: один — для однострочных комментариев, а второй — для многострочных. PHP заимствует синтаксис комментариев из C , C++ и Java . Так что, если вы знакомы с ними, то сюрпризов для вас не будет.
Однострочные комментарии в PHP
Перед комментариями, которые находятся на одной строке, в PHP ставятся два символа косой черты ( // ).
Следующий пример содержит однострочный PHP комментарий в коде:
Однострочный комментарий может находиться на отдельной строке, или добавляется в конец строки кода:
В примере, приведенном выше, препроцессор PHP выполнит функцию echo и проигнорирует все, что расположено после // .
Однострочные комментарии также применяются, чтобы временно убрать строки кода из потока выполнения. Например, следующее изменение предыдущего примера приведет к тому, что PHP проигнорирует всю команду echo во время выполнения:
Многострочные комментарии в PHP
Многострочные комментарии для сайта PHP обернуты разделителями / * и * /. Знак /* обозначает начало блока комментариев, а */ указывает на его конец. Следующий пример демонстрирует использование многострочного комментирования:
Многострочные комментарии полезны, когда заметки, которые вы хотите вставить в код, занимают более одной строки. Возможность помечать блоки строк как комментарии позволяет избежать использования однострочного комментария в начале каждой строки.
Другое полезное применение многострочных комментариев — временное отключение блоков кода PHP . Распространенная практика — написать PHP-скрипт и размышлять, можно ли переписать его так, чтобы он стал более эффективным. В данной ситуации можно закомментировать старый фрагмент кода, чтобы он больше не выполнялся, и написать новый. Если окажется, что новый код хуже оригинала, то можно в PHP удалить комментарии и новый код. А затем раскомментировать старый, чтобы вернуть его в поток выполнения.
Итоги
И однострочные, и многострочные комментарии можно легко добавить в PHP- код , используя специальный синтаксис. Постарайтесь выработать привычку комментировать свой код.
Теперь, когда мы усвоили некоторые базовые понятия PHP , настало время изучить основы этого языка программирования, начиная с введения в переменные PHP .
Полезные клавиатурные сокращения для PHPStorm
Часто при работе в редакторах мы повторяем определенные действия, такие как: создание файла, закрытие вкладок, поиск нужной подстроки в файлах и т.п. Для того, чтобы уменьшить количество действий для достижения нужных результатов существуют так называемые хоткеи / горячие клавиши, которые выполняют определенные, популярные действия в редакторе, экономя наше время при разработке.
На данный момент для работы я использую IDE PHPStorm, соответственно в данной заметке приведу примеры полезных команд именно для этого редактора, которые использую сам.
Я работаю в этом редакторе на Ubuntu и на Маке, соответственно для удобства все написанные команды будут представлены сочетаниями клавиш для обоих систем, клавиши для Linux так же подходят и для версии Windows.
Прежде чем писать конкретные команды для работы с редактором хочется привести пример очень полезной команды, а именно: CTRL + SHIFT + A / Shift + CMD + A (Fine Action) — поиск любого действия в редакторе, другими словами когда вы не знаете где нужная вам команда, но можете сформулировать ключевые слова для этого действия, используйте данное сочетание клавиш.
1) Ctrl / CMD + наведение курсора на интересующую функцию/переменную — показ подробной информации про данную функцию, а если удерживая Ctrl/CMD кликнуть на интересующий нас метод, то нас перекинет на его определение.
2) Ctrl + / / CMD + / (Comment/uncomment with line comment) — закомментировать участок кода с помощью двойного слеша.
3) Ctrl + Shift + / / CMD + Alt + / (Comment/uncomment with block comment) — закомментировать участок кода с помощью комментария вида «/* */»
4) Ctrl + Shift + Backspace / CMD + Shift + Backspace (Last Edition Location) — вернуться к предыдущему месту редактирования, работает так же, даже если до этого вы редактировали другой файл.
5) Ctrl + Alt + L / CMD + Alt + L (Reformat Code) — форматирование кода, актуально как для отдельного файла, так и для всех файлов проекта. В Ubuntu это сочетание клавиш по-умолчанию вызывает блокировку экрана, поэтому нужно будет в настройках либо изменить клавиши, либо изменить сочетание для блокировки экрана (я предпочел вообще отключить данную команду в своей системе).
6) Ctrl + Space / Alt + Space (Basic) — вызов всплывающего окна с подсказками по коду.
7) Alt + Enter (Show Intention Actions) — если PHPStorm обнаруживает ошибки или находит какие-то советы, которые позволяют оптимизировать или упростить код, то он выделяет этот участок подчеркиванием и всплывающим значком лампочки (при наведении на проблемный участок), данное сочетание клавиш позволяет применить рекомендацию системы.
8) CTRL + N / CMD + O (Go to class) — быстрый поиск по именам классов, очень полезно когда у вас большой и сложный проект с множеством классов, которые вы хорошо знаете.
9) Ctrl + Shift + N / CMD + Shift + O (Go to file) — быстрый поиск по названиям файлов, если в проекте много файлов с одинаковыми именами (прим: index.php), то можно набирать вместе с относительным путем до файла, так же прилично экономит время и нервы.
10) CTRL + W / Alt + Стрелка вверх (Select Word at Caret) — выделение логических блоков кода, при повторном нажатии область выделения\блока увеличивается (прим: Переменная -> Метод -> Класс).
11) Двойное нажатие Shift — поиск везде (классы, файлы и т.д.), т.е. как сочетание пунктов 6 и 7.
При публикации заметки использованы материалы:
- PhpStorm — повышаем производительность (клавиатурные сокращения). Часть 1
- Официальная табличка от JetBrains с клавиатурными сокращениями в формате pdf
Как закомментировать строки в файлах шаблона VM ( flypage-ask.tpl.php например ) — [VM1] Дизайн, оформление
Сегодня важный день для проекта Joomla! Мы отмечаем два года напряженной работы наших добровольцев, решивших выпускать новую основную версию каждые два года. После большого количества обсуждений, спринтов по написанию кода и устранения ошибок этот день наконец настал и мы с гордостью объявляем о выпуске новой мажорной ( major ) версии Joomla 5.0, наряду с Joomla 4.4.
В Joomla Extensions Directory появился тег совместимости с Joomla 5.
Joomla-разработчики, проверившие совместимость своих расширений с Joomla 5 могут поставить галочку ��
JoomlaDay Spain, Madrid.
В Мадриде, Испания 5-6 октября 2023 года проходит Joomla Day — конференция, посвящённая как новичкам, так и профессионалам, работающим с Joomla.