Что значит раскомментировать строку

Как закомментировать и раскомментировать строки в файле конфигурации

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

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

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

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

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

# Чтобы включить функцию X, раскомментируйте строку ниже

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

# Чтобы включить функцию X, раскомментируйте строку ниже

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

# Прокомментируйте строку ниже, чтобы отключить функцию Y

# Прокомментируйте строку ниже, чтобы отключить функцию Y

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

Что такое комментарий?

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

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

Например, если вы работаете с PHP-скриптом, вы можете увидеть раздел, подобный приведенному ниже:

/ * Этот раздел закомментирован по умолчанию, чтобы избежать проблем

чтобы включить функцию X, раскомментируйте раздел ниже

другая строка php кода * /

Чтобы раскомментировать раздел и включить функцию, вы должны изменить этот раздел на:

/ * Этот раздел закомментирован по умолчанию, чтобы избежать проблем

чтобы включить функцию X, раскомментируйте раздел ниже * /

другая строка кода php

Это многострочный комментарий PHP (комментарий в стиле C), где / * начинается комментарий и * / заканчивается комментарий.

Источник

1.2 – Комментарии в C++

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

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

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

Обычно однострочный комментарий используется для быстрого комментария к одной строке кода.

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

Однако, если строки длинные, размещение комментариев справа может сделать ваши строки очень длинными. В этом случае однострочные комментарии часто помещаются над строкой, которую они комментируют:

Примечание автора

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

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

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

Пары символов /* и */ отмечают многострочный комментарий в стиле C. Всё, что находится между этими символами, игнорируется.

Поскольку всё, что находится между этими символами, игнорируется, вы иногда можете увидеть, как программисты «украшают» свои многострочные комментарии:

Комментарии в многострочном стиле не могут быть вложенными. Следовательно, результаты следующего кода могут быть неожиданными:

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

Предупреждение

Не используйте многострочные комментарии внутри других многострочных комментариев. Обертывание однострочных комментариев внутри многострочных комментариев допускается.

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

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

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

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

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

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

Вот несколько примеров плохих комментариев к строке и хороших комментариев к инструкции.

Причина: мы уже видим, что прицел (sight) устанавливается на 0, посмотрев на инструкцию.

Причина: теперь мы знаем, почему прицел игрока установлен на 0.

Причина: мы видим, что это расчет стоимости, но почему количество умножается на 2?

Причина: Теперь мы знаем, почему эта формула имеет смысл.

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

Наконец, комментарии должны быть написаны таким образом, чтобы иметь смысл для тех, кто не знает, что делает код. Часто программист говорит: «Совершенно очевидно, что он делает! Я ни за что не забуду об этом,». Угадайте, что? Это не очевидно, и вы удивитесь, как быстро вы забудете. 🙂 Вы (или кто-то другой) поблагодарите вас позже за то, что вы написали, что, как и почему делается в вашем коде на человеческом языке. Читать отдельные строки кода легко. Понимание того, для чего они предназначены, – нет.

Лучшая практика

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

Примечание автора

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

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

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

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

Есть несколько причин, по которым вы можете захотеть это сделать:

Закомментирование кода – обычное дело при разработке, поэтому многие IDE поддерживают комментирование выделенного участка кода. Доступ к этой функции зависит от IDE.

Для пользователей Visual Studio

Вы можете закомментировать или раскомментировать выделенный фрагмент с помощью меню Правка (Edit) → Дополнительно (Advanced) → Закомментировать выделенный фрагмент (Comment Selection) или Раскомментировать выделенный фрагмент (Uncomment Selection).

Для пользователей Code::Blocks

Вы можете закомментировать или раскомментировать выделенный фрагмент с помощью меню Edit (Правка) → Comment (Комментарий) или Uncomment (Раскомментировать) или Toggle comment (Переключить комментарий) или любой другой инструмент для комментирования.

Совет

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

Источник

Как комментировать / раскомментировать в HTML-коде

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

Теперь, если мне нужно скрыть какую-то часть шаблона представления, в случае php я бы просто выбрал желаемый код и поместил однострочные комментарии (в большинстве случаев с помощью сочетания клавиш).

Затем, когда я закончу тестирование, мне придется пройти через агонию, возвращая закрывающие теги.

Есть ли лучший и экономящий время способ блокирования комментариев в HTML?

11 ответов

Закомментируйте большие разделы HTML (закомментируйте блок)

Мой личный путь в файле .html открывается:

Это обходной путь к проблеме, поскольку это не HTML.

Я считаю, что это тоже проклятие комментирования документов в стиле XML. Существуют редакторы XML, такие как eclipse, которые могут выполнять блочное комментирование. Обычно автоматически добавляются дополнительные строки и удаляются. Может быть, они намеренно затруднили комментирование этого стиля документа, ведь все-таки предполагалось, что теги должны быть понятными.

Решение очень похоже на то, что предложил @Robert, работает для меня. Думаю, не очень чисто.

У Eclipse Juno есть хороший способ для этого. Вы просто выполняете cmd + /

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

В зависимости от вашего редактора, написать этот макрос будет довольно легко.

Еще один макрос для отмены этих шагов, и все готово.

Изменить: этот упрощенный подход не обрабатывает вложенные теги комментариев, но должен упростить комментирование / раскомментирование в общем случае.

Источник

Какой быстрый способ комментировать / раскомментировать строки в Vim?

У меня есть файл кода Ruby, открытый в vi, есть строки, закомментированные с # :

для любого, кто смущен использованием, лидер по умолчанию «\», поэтому 10\cc прокомментирует десять строк, а 10\cu раскомментирует эти десять строк

Для комментирования блок текста практически одинаков:

Для урезанной версии vim, поставляемой с debian/ubuntu по умолчанию, вместо этого введите : s/^/# в третьем шаге.

Вот две маленькие записи экрана для наглядности.

Чтобы закомментировать блоки в vim:

Чтобы раскомментировать блоки в vim:

Если вы хотите выбрать несколько символов, используйте один или объедините эти методы:

комментируя с # :

Это вставляет «#» в начале каждой строки. Обратите внимание, что при вводе: диапазон будет заполнен, поэтому он действительно будет выглядеть как :’ norm i#

Не комментирует # :

Если комментарии с отступом, как в вопросе OP, вы можете закрепить удаление следующим образом:

что означает «перейти к первому непробельному символу, затем удалить один символ». Обратите внимание, что в отличие от выбора блока, этот метод работает, даже если комментарии имеют неравные отступы!

Примечание : поскольку norm буквально просто выполняет обычные команды vim, вы не ограничены комментариями, вы также можете выполнить несколько сложных изменений для каждой строки. Если вам нужен escape-символ как часть вашей последовательности команд, введите ctrl-v, затем нажмите клавишу escape (или, что еще проще, просто запишите быстрый макрос, а затем используйте norm для выполнения этого макроса в каждой строке).

/.vimrc, вы можете набрать ctrl-n вместо :norm после того, как сделаете визуальный выбор

(Спасибо @Manbroski и @rakslice за улучшения, включенные в этот ответ)

(Я украл его с какого-то сайта много лет назад, поэтому я не могу полностью объяснить, как он работает :). Существует комментарий где это объясняется.)

Укажите, какие строки комментировать в vim:

Выявить номера строк:

Вот как я это делаю:

Перейти к первому символу в первой строке, которую вы хотите закомментировать.

Удар Ctrl + q в GVIM или Ctrl + v в VIM, затем перейдите вниз, чтобы выбрать первый символ в строках для комментирования.

Затем нажмите c и добавьте символ комментария.

Раскомментирование работает так же, просто введите пробел вместо символа комментария.

Я добавил отображение в обычный и визуальный режимы, но вы можете переназначить все что угодно. Я предпочитаю использовать только функцию стиля «тумблер». Один имеет несколько отображений и т.д.

Переключить комментарии

Installation

Дальнейшая настройка

Я использую vim 7.4, и это работает для меня.
Предполагая, что мы комментируем/раскомментируем 3 строки.

если в начале строки нет табуляции/пробела:
ctrl + V затем jjj затем shift + I (cappital i) затем // then esc esc
если в начале строки есть табуляция/пробел, вы все равно можете сделать выше или поменять местами на c :
ctrl + V затем jjj затем c затем // then esc esc

если строки не имеют табуляции/пробела в начале:
ctrl + V затем jjj затем ll (lower cap L) затем c

если в начале строки есть табуляция/пробел, то вы ставите один пробел и esc
ctrl + V затем jjj затем ll (lower cap L) затем c затем space затем esc

Как раскомментировать следующие три строки в vi:

Как прокомментировать следующие три строки в vi:

Это заглавная буква I, // и Escape.

Когда вы нажимаете ESC все выделенные строки получат указанный вами символ комментария.

Я сопоставил gc и gcc, чтобы прокомментировать строку или выделенный блок кода. Он определяет тип файла и работает очень хорошо.

Да, на этот вопрос уже есть 33 (в основном повторяющихся) ответа.

Этот подход позволит вам делать такие вещи, как:

Все, что вам нужно, это 2 функции, которые работают над движениями, и 2 отображения для каждой функции. Во-первых, сопоставления:

Измените приведенные выше регулярные выражения на свой вкус и укажите, где должен быть # :

Я отмечаю первую и последнюю строки (ma и mb), а затем делаю: ‘a,’ bs/^ # //

Если вы уже знаете номера строк, то n,ms/# // будет работать.

Я объединил ответ Фила и jqno и оставил комментарий без пробелов:

let b:commentChar=’//’ : это создает переменную в vim. b здесь относится к области, которая в данном случае содержится в буфере, то есть к текущему открытому файлу. Ваши символы комментариев являются строками и должны быть заключены в кавычки, кавычки не являются частью того, что будет подставлено при переключении комментариев.

autocmd BufNewFile,BufReadPost *. : автокоманды запускаются для разных вещей, в этом случае они запускаются, когда новый файл или файл чтения заканчивается с определенным расширением. После запуска выполните следующую команду, которая позволяет нам изменять commentChar в зависимости от типа файла. Есть и другие способы сделать это, но они больше сбивают с толку новичков (таких как я).

let l:line=getpos(«‘ : устанавливает переменную так же, как мы делали с нашим комментарием, но l относится к локальной области (локальной для этой функции). getpos() получает позицию, в данном случае, начала нашего выделения, а [1] означает, что мы заботимся только о номере строки, а не о других вещах, таких как номер столбца.

Источник

Что значит раскомментировать строку

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

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

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

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

Стандартный комментарий

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

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

Ниже представлен пример правильно написания:

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

Хотелось бы рассказать о том как можно легко и быстро закомментировать или раскомментировать много строк сразу. В этой статье «Закомментировать/Раскомментировать строки vi/vim в Unix/Linux» я расскажу о небольшой возможности текстового редактора vi/vim.

Закомментировать строки vi/vim в Unix/Linux

Раскомментировать строки vi/vim в Unix/Linux

Во и все, статья «Закомментировать/Раскомментировать строки vi/vim в Unix/Linux» завершена. Если кто-то делает по-другом, напишете свой ход, а я дополню статью. Спасибо.

закомментировать скажем строку, содержащую

Я могу просто запустить эту команду SED:

3 ответов

Да, чтобы прокомментировать строку, содержащую определенную строку с sed, просто сделайте:

и раскомментировать его:

опция » g » в конце означает глобальные изменения. Если вы хотите изменить только один экземпляр шаблона, просто пропустите это.

дополнить @Avinash Raj полезный ответ С более универсальный, POSIX-совместимыми решение.

отметим, что решение awk — based, потому что надежный портативный решение sed практически невозможно из-за ограничений POSIX’ базовый регулярные выражения.

Источник