Поделиться через

Комментарии в коде (Visual Basic)

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

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

Комментарии могут следовать за утверждением на той же строке, либо занимать отдельную строку. Оба иллюстрируются в следующем коде.

' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!"   ' This is an inline comment.

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

' This comment is too long to fit on a single line, so we break 
' it into two lines. Some comments might need three or more lines.

Рекомендации по комментариям

В следующей таблице приведены общие рекомендации по тому, какие типы комментариев могут предшествовать разделу кода. Это предложения; Visual Basic не применяет правила для добавления комментариев. Напишите то, что лучше всего подходит как для вас, так и для тех, кто читает код.

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

Помните следующие моменты:

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

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

  • Примечания не могут следовать последовательности продолжения строки в той же строке.

Вы можете добавлять или удалять символы комментариев для блока кода, выбрав одну или несколько строк кода и выбрав кнопку "Комментарий" (кнопка "Комментарий Visual Basic) и "Раскомментировать" (кнопка "Раскомментировать Visual Basic) на панели инструментов "Изменить".

Замечание

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

См. также