Энциклопедия псевдокода/Соглашения по оформлению кода
Соглашения
Варианты
Варианты реализации описываются в формате: [[вариант1]<---or--->[вариант2]]
Переменные
- Переменные инициализируются формате:
var [имя] = [значение] - Заполнение массива может быть записано в формате:
[имя] = {значение1, ...}, либо,[имя] = {значение1, значение2, ..., значениеN} - Заполнение словаря может быть записано в формате:
[имя] = {ключ1: значение1, ...}, либо,[имя] = {ключ1: значение1, ключ2: значение2, ..., ключN: значениеN}
Классы и записи
- Поля описываются в формате:
[модификатор доступа] [тип] [имя] - Свойства описываются в формате:
[модификатор доступа] property [тип] [имя] [get-set|get|set] - Методы описываются в формате:
[модификатор доступа] [тип] [имя]([параметры]) {} - Конструкторы описываются в формате:
[модификатор доступа] constructor Create([параметры]) {} - Операторы описываются в формате:
operator[оператор]: [тип 1] [элемент 1] [оператор] [тип 2] [элемент 2]
Обобщения
Шаблонные классы и записи (структуры) описываются в формате: type [имя]<[шаблонные параметры]> = [class|struct] end;
Примеры
Описания шаблонного класса
Вариант 1:
type
#Шаблонные параметры:
# T - тип значения узла
TExample<T> = class
{
public property T Value1 get-set
public property T Value2 get
public property T Value3 set
public constructor Create()
{
}
}
Вариант 2:
type
#Шаблонные параметры:
# T - тип значения узла
TExample<T> = class
{
public property T Value1 get-set [field: _value1]
public property T Value2 get [field: _value2]
public property T Value3 set [field: _value2]
public constructor Create()
{
}
}