Перечисленные ниже типы используются для обозначения сигнатур функций в документации. Помимо них также могут использоваться классы.
| Тип | Описание |
|---|---|
any |
Любой тип. |
void |
Тип без значения. |
string |
Строка. |
function |
Функция. |
table |
Таблица. |
char |
Символ. 1 байт. |
bool |
Логический тип, true/false. 1 байт. Возможно уместить в 1 бит. |
int8 |
Целочисленный тип со знаком, 1 байт. |
int16 |
Целочисленный тип без знака. 2 байта. |
int32 |
Целочисленный тип со знаком, 4 байта. |
int64 |
Целочисленный тип со знаком, 8 байт. |
uint8 |
Целочисленный тип без знака. 1 байт. |
uint16 |
Целочисленный тип без знака. 2 байта. |
uint32 |
Целочисленный тип без знака. 4 байта. |
uint64 |
Целочисленный тип без знака. 8 байт. |
float |
Число с плавающей точкой, 4 байта. |
double |
Число с плавающей точкой двойной точности, 8 байт. |
int |
Целочисленный тип со знаком. Синоним int32. |
uint |
Целочисленный тип без знака. Синоним uint32. |
В структурах также можно встретить обозначения типа в следующем формате: uint8 : 4. Данный синтакис указывает на размер типа в битах.
Формат объявления функций в документации:
returnDataType returnDataName1, ..., returnDataTypeN returnDataNameN = functionName(argDataType1 argName1, ..., argDataTypeN argNameN)
returnDataType1..N |
Тип возвращаемых данных. |
returnDataName1..N |
Имена возвращаемых данных. |
functionName |
Имя функции. |
argDataType1..N |
Тип данных параметров функции. |
argName1..N |
Имена параметров функции. |
Тип данных можно не повторять несколько раз если подряд идет одинаковый тип.
Пример:
int a, b, c = getValue(string key, defaultValue)
a, b, c — Имеют тип int.
key, defaultValue — Имеют тип string.