Как закомментировать в PhpStorm целый блок одной клавишей

Как закомментировать в PhpStorm целый блок одной клавишей

От автора: комментирование — это одна из тех функций, которую легко реализовать. В то же время, эти элементы редактирования могут принести немало пользы разработчикам, которые передают код из рук в руки. Сегодня вы узнаете, как в PhpStorm закомментировать блок. Также рассмотрим остальной функционал среды разработки по комментированию содержимого программы.

Комментарии: плохие и хорошие

Возможность комментирования кода доступна на большинстве языков программирования (возможно, на всех, но с разной степенью доступности). Как правило, словесные разъяснения используются для того, чтобы помочь в дальнейшей разработке другим членами команды, или просто напомнить себе о том, что для этого участка нужны исправления (“FIX ME”).

Как закомментировать в PhpStorm целый блок одной клавишей

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

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

JavaScript. Быстрый старт

Изучите основы JavaScript на практическом примере по созданию веб-приложения

Узнать подробнее

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

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

Иногда подобное чувство одолевает и профессионалов. К примеру, когда все выглядит удивительно криво — должно же быть решение получше. Чтобы уберечь последователей от поиска лучшего, программист может оставить такую записку: #time_spent_here=24h

После таких слов мало кто захочет тратить столько времени. Таким образом, вы предупреждаете, что множество разных вариантов уже перебрали. В то же время, стоит избегать таких выпадов: #i_hate_this, #try_to_do_better_ass%%le. Подобным образом вы проявляете лишь непрофессиональное отношение. Не стоит компрометировать себя и работодателя.

Но и документирующее комментирование кода может стать балластом для программиста. Как правило, это массивные участки, которые отвлекают непосредственно от программирования. Но чтобы отобразить код без комментариев, в основных IDE есть соответствующая функция. Не должна быть исключением и PhpStorm, но увы. Ищите функцию в документах обновлений.

Тег, как элемент функционала

Несмотря на то, что комментирование задумывалось как разъяснение и помощь при командной разработке, этими функциями пользуются не так часто. Как правило, теги ставят там, где хотят остановить выполнение кода. Представим, что у вас есть PHP, встроенный в HTML. И вы не хотите его cтирать, а лишь желаете посмотреть, как выглядит страница без него. Для этого необходимо соблюдать такой синтаксис:

Как видите, простыми действиями можно остановить выполнение кода, даже не совершая какой-либо сложных операций. Но, на самом деле, это еще не верх оптимизации. Дополнительное удобство для разработчика предоставляет сама IDE phpStorm. При помощи выделения и сочетания клавиш можно закомментировать выбранный сегмент кода, не приписывая специализированные теги. Осуществить это можно так.

При помощи удобного вам способа выделяете фрагмент текста (мышь, шорткаты).

Жмите сочетание клавиш Ctr + Shift + /

Кроме этого, можно комментировать и текущую строку. Все то же, только без Shift.

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

На этом у нас все. Если ранее вы не пользовались этими функциями, советуем вам начать. Сокращения делают работу быстрее и качественнее.

JavaScript. Быстрый старт

Изучите основы JavaScript на практическом примере по созданию веб-приложения

Узнать подробнее

Разработка веб-приложения на PHP

Создайте веб-приложение на PHP на примере приема платежей на сайте

Получить

Метки:

Похожие статьи:

Комментарии Вконтакте:

Комментарии Facebook:

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