Документация /

О документации

В документации используются следующие виды блоков:

Такой блок содержит код. Если после имени параметра метода стоит знак «=» или «:» — это значит что параметр необязательный, и после такого знака следует его значение по умолчанию.

Такой блок содержит работающий пример.

На такой блок следует обратить внимание.

Для удобства понимания принята следующая нотация в обозначении переменных и параметров:

  • bVar — переменная булевого типа
  • sVar — переменная строкового типа
  • iVar — целочисленная переменная
  • dVar — переменная с плавающей точкой
  • aVar — переменная-массив
  • rVar — переменная, содержащая регулярное выражение
  • fVar — переменная, содержащая функцию
  • oVar — переменная-объект
  • mVar — mixed-переменная. Может быть разных типов в зависимости от контекста