Bitrix закомментировать код php

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

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

Однострочный комментарий в PHP.

Однострочный комментарий в PHP применяется:

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

Однострочный комментарий в PHP это два символа слеша // . В примере кода выше имеется 4 таких комментария.

Любой текст, код который находится за последовательностью символов // будет проигнорировано интерпретатором PHP и не будет обрабатываться.

В результате работы кода выше будет выведена, например такая строка:

Многострочный комментарий

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

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

Гораздо чаще многострочный комментарий будет выглядеть, как:

/* 
* Здесь некоторый текст 
* Еще немного текста 
* . 
*/

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

/* здесь некоторый комментарий */

Наиболее часто в профессиональной разработке на PHP вы будете встречать и использовать сами, многострочные комментарии в стиле PHPDoc (для чего такие комментарии используются, подробнее будет в отдельной статье):

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

Будут ли видны Ваши комментарии в браузере?

Написанный вами PHP код выполняется только на сервере, и результат работы любого скрипта PHP этот текст, который уже отдается в браузер. В случае ВЕБ программирования результатом работы PHP скриптов, как правило является сгенерированыый HTML документ с тегами. И самое главное, что интерпретатор php, выполняя скрипт, игнорирует все строки заключенные в символы комментариев.

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

Резюмируем.

При написании кода на языке программирования PHP принято использовать однострочные комментарии (//………) и многострочные комментарии (/* ………………… */).

Источник

Форум

/*
$aMenuLinksExt = $APPLICATION->IncludeComponent(
«bitrix:menu.sections»,
«»,
array(
«IS_SEF» => «Y»,
«SEF_BASE_URL» => «/ru/products/»,
«SECTION_PAGE_URL» => «#SECTION_CODE#/»,
«DETAIL_PAGE_URL» => «#SECTION_CODE#/#ELEMENT_CODE#/»,
«IBLOCK_TYPE» => «Eliz»,
«IBLOCK_ID» => «5»,
«DEPTH_LEVEL» => «1»,
«CACHE_TYPE» => «A»,
«CACHE_TIME» => «36000000»
),
false
);

Спасибо, Андрей! Убрала! Скажите, а почему у меня теперь меню продублировалось? Т.е. оно вернулось в свой изначальный вид, только оно в 2-х экземплярах.

Андрей, огромное Вам спасибо, что отвечаете.
Я раскомментировала код и вот скажите, пожалуйста, по коду этой страницы что здесь мне убрать, чтобы меню не дублировалоь?
require( $_SERVER [ «DOCUMENT_ROOT» ]. «/bitrix/header.php» );
$APPLICATION -> SetTitle ( «ПРОДУКЦИЯ» );
?> IncludeComponent ( «bitrix:catalog» , «production» , array(
«IBLOCK_TYPE» => «Eliz» ,
«IBLOCK_ID» => «5» ,
«BASKET_URL» => «/personal/basket.php» ,
«ACTION_VARIABLE» => «action» ,
«PRODUCT_ID_VARIABLE» => «id» ,
«SECTION_ID_VARIABLE» => «SECTION_ID» ,
«PRODUCT_QUANTITY_VARIABLE» => «quantity» ,
«PRODUCT_PROPS_VARIABLE» => «prop» ,
«SEF_MODE» => «Y» ,
«SEF_FOLDER» => «/ru/products/» ,
«AJAX_MODE» => «N» ,
«AJAX_OPTION_JUMP» => «N» ,
«AJAX_OPTION_STYLE» => «N» ,
«AJAX_OPTION_HISTORY» => «N» ,
«CACHE_TYPE» => «N» ,
«CACHE_TIME» => «36000000» ,
«CACHE_FILTER» => «N» ,
«CACHE_GROUPS» => «N» ,
«SET_TITLE» => «N» ,
«SET_STATUS_404» => «Y» ,
«USE_ELEMENT_COUNTER» => «N» ,
«USE_FILTER» => «Y» ,
«FILTER_NAME» => «arFilS2T» ,
«FILTER_FIELD_CODE» => array(
0 => «ID» ,
1 => «CODE» ,
2 => «XML_ID» ,
3 => «NAME» ,
4 => «TAGS» ,
5 => «SORT» ,
6 => «PREVIEW_TEXT» ,
7 => «PREVIEW_PICTURE» ,
8 => «DETAIL_TEXT» ,
9 => «DETAIL_PICTURE» ,
10 => «DATE_ACTIVE_FROM» ,
11 => «ACTIVE_FROM» ,
12 => «DATE_ACTIVE_TO» ,
13 => «ACTIVE_TO» ,
14 => «SHOW_COUNTER» ,
15 => «SHOW_COUNTER_START» ,
16 => «IBLOCK_TYPE_ID» ,
17 => «IBLOCK_ID» ,
18 => «IBLOCK_CODE» ,
19 => «IBLOCK_NAME» ,
20 => «IBLOCK_EXTERNAL_ID» ,
21 => «DATE_CREATE» ,
22 => «CREATED_BY» ,
23 => «CREATED_USER_NAME» ,
24 => «TIMESTAMP_X» ,
25 => «MODIFIED_BY» ,
26 => «USER_NAME» ,
27 => «» ,
),
«FILTER_PROPERTY_CODE» => array(
0 => «» ,
1 => «FILTER_RUKAV» ,
2 => «FILTER_SOSTAV» ,
3 => «FILTER_TRADEMARKS» ,
4 => «» ,
),
«FILTER_PRICE_CODE» => array(
),
«FILTER_VIEW_MODE» => «VERTICAL» ,
«USE_COMPARE» => «N» ,
«PRICE_CODE» => array(
),
«USE_PRICE_COUNT» => «N» ,
«SHOW_PRICE_COUNT» => «1» ,
«PRICE_VAT_INCLUDE» => «N» ,
«PRICE_VAT_SHOW_VALUE» => «N» ,
«PRODUCT_PROPERTIES» => array(
),
«USE_PRODUCT_QUANTITY» => «N» ,
«SHOW_TOP_ELEMENTS» => «Y» ,
«TOP_ELEMENT_COUNT» => «9» ,
«TOP_LINE_ELEMENT_COUNT» => «3» ,
«TOP_ELEMENT_SORT_FIELD» => «sort» ,
«TOP_ELEMENT_SORT_ORDER» => «asc» ,
«TOP_ELEMENT_SORT_FIELD2» => «id» ,
«TOP_ELEMENT_SORT_ORDER2» => «desc» ,
«TOP_PROPERTY_CODE» => array(
0 => «» ,
1 => «» ,
),
«SECTION_COUNT_ELEMENTS» => «Y» ,
«SECTION_TOP_DEPTH» => «1» ,
«SECTIONS_VIEW_MODE» => «TEXT» ,
«SECTIONS_SHOW_PARENT_NAME» => «Y» ,
«PAGE_ELEMENT_COUNT» => «9» ,
«LINE_ELEMENT_COUNT» => «3» ,
«ELEMENT_SORT_FIELD» => «sort» ,
«ELEMENT_SORT_ORDER» => «asc» ,
«ELEMENT_SORT_FIELD2» => «id» ,
«ELEMENT_SORT_ORDER2» => «desc» ,
«LIST_PROPERTY_CODE» => array(
0 => «NAME_EN» ,
1 => «DETAIL_TEXT_EN» ,
2 => «» ,
3 => «» ,
),
«INCLUDE_SUBSECTIONS» => «Y» ,
«LIST_META_KEYWORDS» => «-» ,
«LIST_META_DESCRIPTION» => «-» ,
«LIST_BROWSER_TITLE» => «-» ,
«DETAIL_PROPERTY_CODE» => array(
0 => «» ,
1 => «» ,
),
«DETAIL_META_KEYWORDS» => «-» ,
«DETAIL_META_DESCRIPTION» => «-» ,
«DETAIL_BROWSER_TITLE» => «NAME» ,
«LINK_IBLOCK_TYPE» => «Eliz» ,
«LINK_IBLOCK_ID» => «5» ,
«LINK_PROPERTY_SID» => «» ,
«LINK_ELEMENTS_URL» => «link.php?PARENT_ELEMENT_ID=#ELEMENT_ID#» ,
«USE_STORE» => «N» ,
«PAGER_TEMPLATE» => «step2tops» ,
«DISPLAY_TOP_PAGER» => «N» ,
«DISPLAY_BOTTOM_PAGER» => «Y» ,
«PAGER_TITLE» => «Товары» ,
«PAGER_SHOW_ALWAYS» => «N» ,
«PAGER_DESC_NUMBERING» => «N» ,
«PAGER_DESC_NUMBERING_CACHE_TIME» => «36000» ,
«PAGER_SHOW_ALL» => «N» ,
«ADD_PICT_PROP» => «-» ,
«LABEL_PROP» => «-» ,
«MESS_BTN_BUY» => «Купить» ,
«MESS_BTN_ADD_TO_BASKET» => «В корзину» ,
«MESS_BTN_COMPARE» => «Сравнение» ,
«MESS_BTN_DETAIL» => «Подробнее» ,
«MESS_NOT_AVAILABLE» => «Нет в наличии» ,
«DETAIL_USE_VOTE_RATING» => «N» ,
«IMG_HEIGHT» => «346» ,
«IMG_WIDTH» => «231» ,
«DETAIL_BRAND_USE» => «N» ,
«AJAX_OPTION_ADDITIONAL» => «» ,
«SEF_URL_TEMPLATES» => array(
«sections» => «» ,
«section» => «#SECTION_CODE#/» ,
«element» => «#SECTION_CODE#/#ELEMENT_CODE#/» ,
«compare» => «compare.php?action=#ACTION_CODE#» ,
),
«VARIABLE_ALIASES» => array(
«compare» => array(
«ACTION_CODE» => «action» ,
),
)
),
false
); ?>

Источник

Правила оформления PHP-кода

При комментировании кода следует использовать PHPDoc комментарии.

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

Переменные

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

Префиксы

В именах переменных используются следующие префиксы:

• ar — для массивов
• db — для CDBResult
• b — для булевых переменных, если из имени не очевидно. Перфикс обязателен, если булевое значение используется там, где обычно хранится строковое Y/N.

$arUserList = array(); $dbRes = CIBlockElement::GetByID($id); $bActive = false;

Имена переменных не должны начинаться с подчеркивания.

Глобальные переменные

Глобальные переменные пишутся ЗАГЛАВНЫМИ буквами с разделением слов знаком подчеркивания.

global $USER, $APPLICATION, $AR_MESSAGES.

Использование глобальных переменных допускается лишь там, где это абсолютно необходимо. Используйте то, что даёт D7, там, где он это даёт!

Локальные переменные

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

Данное правило распространяется на аббревиатуры.
Т.е. станция BBC пишется $bbcStation; $arBbcStations; .

Исключение только одно — ID записывается заглавными.
Т.е. $sectionID , $arElementIDs .

$counter = 0; $bElementActive = false; $lastErrorMsg = ''; $ID = $_GET['ID'];

Вспомогательные (временные) переменные

Переменные, используемые в конструкциях FOR. FOREACH, допускается именовать сокращенно, если код блока, в котором они используются, просматривается без прокрутки страницы.

for ($i = 0; $i < count($arRows); $i++) < // . >foreach ($arElement as $k => $v) < // . >while ($arr = $dbRes->Fetch()) < // . >

Константы

Имена констант записываются ЗАГЛАВНЫМИ буквами, слова разделяются знаком подчеркивания. В связи с глобальной областью видимости константы необходимо предварять коротким префиксом (по имени модуля, компонента, шаблона).

Символьные коды Битрикс

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

Где пишем	Как пишем
В инфоблоках:	UPPER_CASE
В элементах инфоблоков:	lower-case
В разделах:	lower-case
Ключи массивов arParams, arResult:	UPPER_CASE
Ключи массива языковых файлов:	UPPER_CASE

Именование классов, методов, функций

• Имена классов всегда начинаются с заглавной буквы. Слова отделяются капитализацией первой буквы. (CamelCase)
• Имена методов, функций всегда начинаются с маленькой буквы. Слова отделяются капитализацией первой буквы. (camelCase)

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

Оформление управляющих структур

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

Инструменты для автоформатирования кода, настройка параметров

[Плагины для SublimeText]

• PhpDoc — Собственно плагин для поддержки PHPDoc формата.
• phpfmt — плагин для автоматического форматирования php-кода (требует установленного php).

Конфиг для плагина phpfmt:

Источник

Как закомментировать на время код HTML, CSS или PHP, JS

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

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

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

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

ошибки в комментариях к коду — по версиям php

php 8

время от времени языки программирования меняются (их версии), а следовательно относитесь внимательнее к тому, что и как комментируете!

Как известно, не так давно вышла версия php 8 — некоторые пользователи столкнулись с проблемами!

В данной статье коснемся, скажем так, синтаксиса — правописания))…

Например, если комментируете в самом финале кода, то обязательно соответственно закрывайте комментарий! иначе, в новейших версиях php (подобные правила касаются многих ЯПов) бесконечно закомментированный блок вызовет ошибки! Белый экран.

…далее: никогда не ЛЕПИТЕ друг к дружке символы комментариев к тегам кода. неряшество в коде, как и в жизни, вызывает неприличные ошибки.

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

Источник