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

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

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

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

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

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

Правила комментирования

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

Также рекомендуется принять во внимание следующие моменты.

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

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

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

Источник

Comments in Code (Visual Basic)

As you read the code examples, you often encounter the comment symbol ( ‘ ). This symbol tells the Visual Basic compiler to ignore the text following it, or the comment. Comments are brief explanatory notes added to code for the benefit of those reading it.

It is good programming practice to begin all procedures with a brief comment describing the functional characteristics of the procedure (what it does). This is for your own benefit and the benefit of anyone else who examines the code. You should separate the implementation details (how the procedure does it) from comments that describe the functional characteristics. When you include implementation details in the description, remember to update them when you update the function.

Comments can follow a statement on the same line, or occupy an entire line. Both are illustrated in the following code.

If your comment requires more than one line, use the comment symbol on each line, as the following example illustrates.

Commenting Guidelines

The following table provides general guidelines for what types of comments can precede a section of code. These are suggestions; Visual Basic does not enforce rules for adding comments. Write what works best, both for you and for anyone else who reads your code.

Remember the following points:

Every important variable declaration should be preceded by a comment describing the use of the variable being declared.

Variables, controls, and procedures should be named clearly enough that commenting is needed only for complex implementation details.

Comments cannot follow a line-continuation sequence on the same line.

You can add or remove comment symbols for a block of code by selecting one or more lines of code and choosing the Comment ( ) and Uncomment ( ) buttons on the Edit toolbar.

You can also add comments to your code by preceding the text with the REM keyword. However, the ‘ symbol and the Comment/Uncomment buttons are easier to use and require less space and memory.

Источник

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

Комментирование кода в Visual Bassic.

В Visual Bassic есть несколько видов комментариев.
Рассмотрим основные на изображении(см. изображение):

Что такое комментарии кода и для чего они нужны?
Комментарии, это произвольный текст, или иными словами заметки/напоминалки программиста, чтобы спустя какое-то время взглянув на код, не ломать голову и не вспоминать что делает тот или иной участок кода.
При выполнении кода, программа никак не учитывает комментарии, поэтому в комментариях к коду можно писать всё что угодно.

Как поставить комментарии?
См. изображение выше.
Первый вид комментариев, это текст расположенный за одинарной кавычкой.
И второй вид комментариев, это текст расположенный за ключевым словом REM.

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

Сочетанием клавиш можно не только комментировать код, но и убрать комментарии. Например вышеуказанным сочетанием клавиш ты закомментировал 100 строчек кода, а потом тебе понадобилось раскомментировать большое количество строк кода. Делать удаление вручную нудно и долго, поэтому, если нужно убрать комментарий с большого количества строк, то делай так.
Выделяем нужный код и нажимаем:
Ctrl + K + U (буквы английские, выбранный язык в момент нажатия значения не имеет)

Ещё один способ многострочного комментирования.
Находясь вне процедур, функций и циклов можно сделать так:

Источник

Урок 1 по VBScript: Синтаксис vbs сценариев

В этом начальном уроке, мы изучим синтаксис vbscript языка. Синтаксис языка vbscript является таким же как и в языке Visual Basic и фактически, является подмножеством данного языка программирования. Основной упор в использовании vbscript – это возможность написания сценариев (расширение vbs) с открытым кодом для платформы Windows. Пользователю не нужно прибегать к установке дополнительного программного обеспечения, так как все сценарии выполняются под управлением сервера сценариев Windows Script Host.

И так, давайте рассмотрим базовый синтаксис vbscipt и его возможности.

Можно прописать несколько операторов в одну строчку, для этого используется знак двоеточия (:). Сам язык нечувствителен к регистру символов.

Хорошо, давайте рассмотрим синтаксис языка vbscript на таком примере:

Видим, что тут, мы вначале прописали комментарии, далее объявили три переменные. Как видим, язык vbscript не требует назначения типа данных (более детально, работу с типами данных я рассмотрел в статье – «Урок 3 по VBScript: Типы данных»). В конце, для вывода данных мы использовали функцию MsgBox, в данном случае она прописана в упрощенном варианте. Давайте рассмотрим ее полный синтаксис:

MsgBox(prompt[, buttons] [, title ][, helpfile, context ] ) – видим, что тут, функции передаются пять параметров, последние два мы рассматривать не будет, так как они не являются актуальными и практически не применяются.

Работу с данной функцией я более детально рассмотрел в статье «Создание диалоговых окон».

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

Sub MyProcedure(Param1, Param2)
Строки кода
End Sub

Если процедура не имеет параметров, то в скобках после имени ничего ука­зывать не нужно:

Sub MyProcedure()
…

End Sub

Function MyFunction(Param1, Param2) … End Function

Для того чтобы возвратить из функции какое-либо значение, нужно внутри неё присвоить это значение переменной, название которой совпадает с именем функции:

Function MyFunction(Param1, Param2)
Dim Sum
Sum = Paraml+Param2
MyFunction = Sum
End Function

Если возвращаемое функцией значение не нужно присваивать никакой пе­ременной, то функция вызывается так же, как и процедура — пишется имя этой функции и через пробел указывается список ее аргументов: MyFunction 3,5

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

Вот простой пример синтаксиса vbscript для использования собственных процедур и функций:

Помимо процедур и функций, можно создавать собственные массивы (Урок 9 по VBScript: Массивы) и классы (Урок 8 по VBScript: Объекты и классы)

Ну что же, вдобавок, хотелось бы упомянуть две очень полезные функции:

Смотрим на третий пример:

Спасибо за внимание. Автор блога Владимир Баталий

Источник

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

Справочник по языку VBScript

Язык VBScript (Visual Basic Script Edition) является урезанной версией языка Microsoft Visual Basic, поэтому для тех, кто программировал на Visual Basic или VBA, язык VBScript окажется очень знакомым.

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

В отличие от JScript, для сценариев VBScript в конце строки не нужно ставить точку с запятой. В случае необходимости написания одного оператора на нескольких строках в конце этих строк нужно ставить символ подчеркивания «_»:

Комментарием в VBScript считаются все символы в строке, идущие после символа апострофа

Rem Этот комментарий занимает всю строку

Переменные в VBScript могут быть глобальными (доступными из любого места сценария) и локальными (область действия ограничивается блоком кода, в котором они определены). Все переменные VBScript имеют стандартный тип

По умолчанию переменные в VBScript можно предварительно не объявлять; для включения режима обязательного объявления переменных нужно вставить в самую первую строку сценария выражение

Язык VBScript является регистро-независимым, т.е. имена

? имя переменной должно начинаться с буквы и не должно содержать символа «

? имя переменной не должно превышать 255 символов.

Значения переменным в VBScript присваиваются с помощью оператора «

Dim MyVariable MyVariable = «Привет!»

Здесь мы объявили переменную

Хотя в VBScript определен только один тип

Таблица П2.1. Подтипы данных