Формат исходного кода на VBScript

Материал из GedeminWiki
Перейти к: навигация, поиск

Ниже приводятся требования к формату исходного кода, написанного на языке VBScript.

Требования к формату исходного кода

  • Зарезервированные слова (Begin, End, While etc.) набираются строчными буквами с заглавной прописной.
  • Следующие символы и последовательности символов выделяются пробелами с двух сторон: + - * / = < > <> >= <=^ Пример:
Value = A + 5 / 6
  • Следующие символы выделяются пробелом справа: : ; , Пример:
A = B + C
D = E * F
MyFunc(A, B)
  • Следующие символы не выделяются пробелами: ( ) . . Пример:
MyFunc(A, B)
Obj.Function(A)
  • Не рекомендуется набирать операторы If...Then...Else в одну строку.
  • Стандартный отступ — 2 пробела. Символ табуляции не используется.
  • Отступами выделяются:
  • Оператор после зарезервированных слов Then, Else, While, etc.
If A > B Then
  Result = A
Else
  Result = B
End If
	
While A < 100 	  
  A = A + 1
WEnd

При объявлении класса, секции следуют в следующем порядке: Private, Public. Если секция пустая, т.е. не содержит объявлений методов, переменных или properties, то она не указывается в объявлении класса. Начало каждой секции (кроме первой) выделяется пустой строкой. В пределах одной секции объявления переменных, методов и properties отделяются друг от друга пустыми строками. Кроме этого пустые строки используются для выделения логических групп (конструктор и деструктор отделяются от других методов; переменные, хранящие значения properties отделяются от других переменных и т.п.). Реализация методов класса происходит в обратном порядке, т.е. сначала Public методы, затем Protected и Private, причем в пределах одной секции реализация методов происходит в порядке их объявления.

Пример:

  • При переносе длинной строки вторая, третья и все последующие части набираются с отступом относительно первой, причем операторы оставляются в конце предидущей строки:
VeryLongIdentifier = FirstVariable /_
  SecondVariable *_
  (ThirdVariable + FourthVariable)
  • Комментарии должны быть написаны грамотным английским, белорусским или русским языком.
  • Всегда использовать константы вместо непосредственных значений.
  • Составной оператор должен умещаться на один экран, т.е. быть не длиннее чем в 20-25 строк кода.
  • Закрывающий End должен находиться на одном уровне с открывающим Begin.
Персональные инструменты
Пространства имён

Варианты
Действия
Навигация
Инструменты