Share via

Условные обозначения и соглашения о коде (Visual Basic)

  • Статья

В документации Visual Basic используются следующие соглашения о типографических и кодовых соглашениях.

Типографические соглашения

Пример Description
Sub, , IfPrintChDirTrue,Debug В ключевое слово языка и членах среды выполнения имеются начальные прописные буквы и форматируются, как показано в этом примере.
SmallProject, ButtonCollection Слова и фразы, которые вы научили вводить, форматируются, как показано в этом примере.
Оператор Module Ссылки, которые можно щелкнуть, чтобы перейти на другую страницу справки, форматируются, как показано в этом примере.
object, variableName, argumentList Заполнители для сведений, которые вы предоставляете, форматируются, как показано в этом примере.
[ Тени ], [ expressionList ] В синтаксисе необязательные элементы заключены в квадратные скобки.
{ } Public | Friend | Private В синтаксисе при выборе между двумя или более элементами элементы заключены в фигурные скобки и разделены вертикальными полосами.

Необходимо выбрать один и только один из элементов.
[ ] Protected | Friend В синтаксисе при выборе между двумя или более элементами элементы заключены в квадратные скобки и разделены вертикальными полосами.

Вы можете выбрать любое сочетание элементов или нет элемента.
[{ ByVal | ByRef }] В синтаксисе, если вы можете выбрать не более одного элемента, но вы также можете опустить элементы полностью, элементы заключены в квадратные скобки, окруженные скобками и разделенными вертикальными полосами.
memberName 1, memberName2, memberName3 Несколько экземпляров одного заполнителя различаются по подстрокам, как показано в примере.
memberName1

...

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

В коде многоточие означает код, опущенный ради ясности.
ESC, ВВОД Имена ключей и последовательности клавиш на клавиатуре отображаются во всех прописных буквах.
ALT + F1 Если знаки плюса (+) отображаются между именами ключей, необходимо удерживать один ключ при нажатии другого. Например, ALT+F1 означает удержание клавиши ALT при нажатии клавиши F1.

Соглашения о коде

Пример Description
sampleString = "Hello, world!" Примеры кода отображаются в шрифте фиксированного шага и форматируются, как показано в этом примере.
Предыдущая инструкция задает значение sampleString "Hello, world!" Элементы кода в пояснительном тексте отображаются в шрифте фиксированного шага, как показано в этом примере.
' This is a comment.

REM This is also a comment.		 Комментарии кода представлены апострофом (') или ключевое слово REM.
sampleVar = "This is an " _

& "example" _

& " of how to continue code."		 Пробел, за которым следует символ подчеркивания (_) в конце строки, указывает, что инструкция продолжается на следующей строке.

См. также