Как закомментировать группу строк в с шарп

Visual Studio Hotkeys

Многие из нас пользуются всевозможными плагинами, расширениями для Visual Studio. Стоит заметить что многие из них довольно удобны. А вкупе с code snippets значительно ускоряют работу. Тем кто ещё не знаком с такими «плюшками» настоятельно порекомендую попробовать и использовать.

Что касается меня, я пользовался Visual Assist, позже попытался использовать R#. Но если от первого я отказался когда перестал программировать на С++, то второй «убивал» напрочь мой компьютер, если я пытался открыть больше 2х студий. Не смотря на то, что сейчас и компьютер помощнее и R# несомненно улучшили, я не использую его. Связано это с тем, что я нашёл тогда возможность «вздохнуть» более свободно, используя «горячие клавиши».

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

Схемы разработки

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

Так же в этом меню, вы можете добавить или удалить хоткеи «заточив» ещё больше под себя. Настройка довольно проста. Описанные примеры я буду рассматривать для схемы Visual C# 2005.

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

Есть несколько комбинаций клавиш, для создания комментирования:
Ctrl+E,C — закоментировать выбранные линии в коде.
Ctrl+E,U — раскомментировать выбранные линии в коде.
Если перед имененм метода набрать /// — автоматически будут добавлены XML комментарии, которые потом можно использовать для создания документации.

Поиск

Кто-то пользуется поиском для рефакторинга, кто-то для ознакомления со своим же кодом, жизнь можно улучшить довольно легко:

Ctrl+F — открывается стандартное окно поиска, если в буфер недавно было скопирован текст, то он автоматически подставиться.
Ctrl+F3 — поиск «активного» текста вниз (который выделен или слово на котором стоит курсор), без копирования в буфер обмена.
Ctrl+Shift+F3 — поиск «активного» текста вверх.
Ctrl+I — и начинаете печатать текст, этакий runtime поиск.

Вызов базового джина

Вам лень писать текст полностью?! Скорость выпадающего Intellisence не устраивает несущуюся впереди вас вашу мысль?! Тогда самое время применить следующии комбинации:
Ctrl+Space — вызов Intellisence с показом «слов»
Ctrl+J — если вы подзабыли название метода класса или его свойсто, то эта комбинация вам поможет. Можно применять и предыдущую, но эта более «умная».
Ctrl+K, X — показ всех сниппетов, которые у вас есть, в виде выпадающего списка, использование интуитивно понятно 🙂 короткое_имя_снипета+Tab — использовать сниппет в коде. Список базовых сниппетов можно посмотреть здесь. Себе я сделал немного урезанный вариант и повесил рядом с монитором.

Навигация по коду

Тут стоит сказать отдельно и довольно много, навигация очень удобная, особенно когда привыкаешь 🙂
F12 — перейти к определению/объявлению класса/метода/свойства. Очень применимо если вам вдруг стало интересно, а реализуется ли этой переменной, этого класса тип интерфейс IDisposable; или вы ищите в коде, «а где же объявляется эта переменная».
Ctrl+G — перейти на определённый номер строки в коде. (Отображение номеров строк можно включить: Text Editor -> Интересующий вас язык -> Display -> Line numbers — выставить галку). Иногда довольно удобно, особенно если получаете описание необработанного исключения, а там указан, как правило, номер строки.
Ctrl+] — когда курсор установлен на скобку, многострочный комментарий (/* */), регион (#region), строку, обрамлённую кавычками, эта комбинация позволит вам увидеть начало и окончание этих «блоков», перемещая курсор между ними.
Ctrl+M, M — я человек довольно ленивый и мне сложно заставить долго тыкать мышкой по ±, сворачиваю и разворачия «блоки», поэтому рекомендую данную комбинацию
Ctr+M, O — комбинация аналогичная предыдущей, только сворачивает все блоки
Ctrl+- — переход к предыдущему активному тексту (тому который вы редактировали)
Ctrl+Shift+- — переход к следующему активному тексту, если он конечно есть 😉

Если обратите внимание то студия, по своей природе MDI, значит должна быть возможность перемещаться, между окнами:
Ctrl+Tab — аналог Alt+Tab в Windows, только применимо к студии.

Очень удобным инструментом в студии являются закладки, да-да, по аналогии с книжными. Можно отметить код чтобы потом перейти к нему:
Ctrl+B, T — поставить/снять закладку.
Ctrl+B, Ctrl+C — удалить все закладки.
Ctrl+B, N — перейти к следующей закладке.
Ctrl+B, P — перейти к предыдущей закладке.

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

Многие знают и используют Ctrl+C и Ctrl+V, но студия обладает ещё рядом удобным комбинаций:
Ctrl+Shift+V — не отпуская Ctrl+Shift и нажимая на V, вы сможете вставить один из 10 последних кусков текста, скопированных в буфер обмена.
Tab — увеличить отступ.
Shift+Tab — уменьшить отступ.
Мне иногда не хватало вертикального выделения текста, бывает полезно. Оказывается и такая возможность есть! Стоит нажать Alt, и не отпуская, выделять мышкой текст. Но есть минус — меню и стрелочки клавиатуры :). Это решаемо, нажимаете Shift+Alt и используете стрелочки Left или Right

Если код доставшийся вам «грязен», не только по структуре, но и по внешнему оформлению, используйте:
Ctrl+E+D — форматирование всего документа, позволяет привести документ в более удобоваримый вид.
Ctrl+E+F — форматирование выбранной части текста

Иногда в целях рефакторинга или ещё каких-то благих начинаниях, есть смысл перевести все буквы в верхний или нижний регистр:
Ctrl+Shift+U — перевести выделенный блок в верхний регистр
Ctrl+U — перевести выделенный блок в нижний регистр

Небольшой экскурс в сборку и отладку

Конечно же со стороны хоткеев 🙂
Начнём со «сборки»:
Ctrl+Shift+B или F6 — собрать solution.
Shift+F6 — собрать активный проект.
Если появились ошибки, это плохо, но никто от них не застрахован:
F5 — запустить программу, с возможностью отладки. Или продолжить выполнение программы, после точки останова.
Ctrl+F5 — запустить программу без отладки
F9 — поставить/убрать точку останова — breakpoint
Ctrl+Shift+F9 — удалить все точки останова.
F10 — выполнить код, без захода внутрь
F11 — выполнить код, с заходом внутрь

В режиме отладки есть два типа просмотра — Watch и QuickWatch. Разница между ними выходит за рамки данного топика :). Однако, вызвать QuickWatch вы можете нажав Ctrl+D, Q. Просто Watch — Ctrl+D, W.

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

• February 2014 (1)
• January 2014 (1)
• March 2013 (2)
• February 2013 (2)
• November 2012 (1)
• October 2012 (2)
• July 2012 (3)
• May 2012 (2)
• January 2012 (4)
• December 2011 (3)
• November 2011 (14)
• October 2011 (1)

Code Comments

При написании кода вы быстро привыкнете к тому, что большинство слов и символов имеют особое значение. Например в C#, вы увидите различные ключевые слова, такие как: class, namespace, public и т.д. Вы заметите, что компилятор будет следить за их правильным использованием, точно так-же как он следит за использованием вами ваших методов и переменных. C# — довольно строгий язык, но компилятор поможет вам ввести всё правильно и укажет на ошибку если вы её допустите. Тем не менее существует один способ писать что угодно благодаря комментариям.

Возможно вы уже сталкивались с комментариями в коде. Будь то C# или другой язык программирования — концепция комментариев довольно универсальна. Давайте же рассмотрим какие типы комментариев бывают в C# и как их использовать.

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

Самый простой и наиболее распространённый тип комментария в C# — однострочный комментарий. Как вы наверно догадываетесь из его названия, он превращает в комментарий одну строчку. Давайте посмотрим как это выглядит на примере:

// My comments about the class name could go here. 
class Program
 . 

Всё просто: добавьте в начале строки две косые черты ( «//» ) и ваша строчка перестанет интересовать компилятор от слова «совсем» — теперь это комментарий! А если вам понадобится больше одной строки для записей, вы легко можете закомментировать этим способом несколько строк подряд:

// My comments about the class name could go here. 
// Add as many lines as you would like
// . Seriously!
class Program
 . 

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

Если вы хотите комментировать несколько строк кода как единый блок, то имеет смысл использовать многострочные комментарии. Всё, что находится между этими символами /* */ — игнорируется:

/* 
My comments about the class name could go here. 
Add as many lines of comments as you want 
. and use indentation, if you want to! 
*/ 
class Program 
 . 

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

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

Документационные комментарии

Документационные комментарии (часто называемые XML документационные комментарии) выглядят как обычные комментарии, но с использованием XML. Как и обычные комментарии, они состоят из двух типов: однострочные и многострочные. Пишутся они таким же образом, но с дополнительным символом. Однострочные XML документационные комментарии используют три слеша (///) вместо двух, а многострочный вариант — получает дополнительную звездочку в начальном маркере. Давайте посмотрим, как это выглядит:

class User
 /// 
 
/// The Name of the User. 
///
 
public string Name < get; set; >
 
/** 
* 
The Age of the User.
 
*/ 
public string Age < get; set; >
>

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

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

Комментарии кода и список задач

Если вы используете Visual Studio, то можно облегчить работу с комментариями. В окне Список задач (можно получить доступ через меню Вид > Список задач) появятся ваши комментарии, если они используют специальный, но в тоже время очень простой синтаксис списка задач:

//TODO: Change "world" to "universe"
Console.WriteLine("Hello, world!");
//HACK: Don't try this at home. 
int answerToLife = 42;

Таким образом, если однострочный комментарий начинается с TODO или HACK, то он будет вот так отображен в Списке задач Visual Studio:

И существуют некоторые другие типы — в зависимости от версии, которую вы используете, Visual Studio будет работать с некоторыми или даже всеми обозначениями:

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

Резюме

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

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

This article has been fully translated into the following languages:

Is your preferred language not on the list? Click here to help us translate this article into your language!

Комментирование кода в C#

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

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

Итак, C# поддерживает несколько видов комментариев, которые мы далее и рассмотрим.

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

// Это однострочный комментарий
Console.WriteLine(«Привет комментарии в C#»); // Это тоже однострочный комментарий, но на другой строке

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

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

Начинаются с символов /* и заканчиваются символами */. Могут распространяться на несколько строк.

/*
Это многострочный комментарий, который
может распространяться на несколько строк
*/
Console.WriteLine(«Привет комментарии в C#»);

Комментарии, использующие XML-теги

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

///

/// Это метод возвращает код состояния
///

public StatusCode GetSensorStatus();

Таким образом, вот такие виды комментариев существуют в C#. Однако, имейте ввиду, что комментировать стоит только те участки кода, которые будут в дальнейшем трудны для понимания. Не стоит комментировать все подряд.

Создано 12.11.2020 13:31:49

Михаил Русаков

Копирование материалов разрешается только с указанием автора (Михаил Русаков) и индексируемой прямой ссылкой на сайт (http://myrusakov.ru)!

Добавляйтесь ко мне в друзья ВКонтакте: http://vk.com/myrusakov.
Если Вы хотите дать оценку мне и моей работе, то напишите её в моей группе: http://vk.com/rusakovmy.

Если Вы не хотите пропустить новые материалы на сайте,
то Вы можете подписаться на обновления: Подписаться на обновления

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

Порекомендуйте эту статью друзьям:

Если Вам понравился сайт, то разместите ссылку на него (у себя на сайте, на форуме, в контакте):

1. Кнопка:
   Она выглядит вот так:
2. Текстовая ссылка:
   Она выглядит вот так: Как создать свой сайт
3. BB-код ссылки для форумов (например, можете поставить её в подписи):

Комментарии ( 0 ):

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

Copyright © 2010-2023 Русаков Михаил Юрьевич. Все права защищены.

Комментарии в Паскаль (Pascal)

Июнь 11th, 2013 admin

Как известно, написать код — это еще не залог успеха. Этот код нужно комментировать. Это является залогом успеха. Даже если Вы через год откроете свою программу в Паскале и почитаете свои комментарии, то сразу разберетесь. В языке Паскаль (Pascal), как и во многих других языках программирования существуют комментарии.

Комментарии разделяют на строчные и блочные. Строчный комментарий обычно комментирует одну строку и начининается с двух бэкслэшей (//). Блочный комментарий способен закомментировать несколько строк одновременно (обозначение <>).

Program comments; Var a,b:Integer; // тут строчный комментарий Begin // WriteLn('Введите число'); a:=0; b:=10; for a:=1 to 10 do begin Write (a*b, ' '); end; < Это блочный комментарий for a:=1 to 10 do begin Write (a*b, ' '); end; все что внутри не исполняется>End.

Чем отличаются комментарии — вроде все понятно с первого раза. Но чем же они отличаются? Строчный комментарий создан для использования пользователем для комментирования своего кода. А блочный комментарий — для отладки приложения. Представим такой момент: вы закомментировали часть кода блочно, и на ваше место пришел коллега. Решил часть блока кода отладить и закомментировал блочно. Что произойдет в данной ситуации? Путаница.

Program comments; Var a,b:Integer; // тут строчный комментарий Begin // WriteLn('Введите число'); a:=0; b:=10; все что внутри не исполняется> End.

Вывод один: лучше комментировать свой код строчными комментариями, а отлаживать блочными.

. комментарий в pascal-программе следует комментарий паскаль как написать комментарий в паскале pascal комментарийй комментарии в паскаль

. turbo pascal комментарии как в языке паскаль обозначаются косиности и синусы pascal комментарии pascal комментарии комментарии языка паскаль

Опубликовано в рубрике Pascal