О форматировании кодов

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

Имена функций и переменных будем делать английскими буквами с применением английских же слов. Никакой латиницы (eto_peremennaya) - от нее больше вреда чем пользы. Все переменные, функции и проч. будем использовать в нижнем регистре (вдобавок при принудительном форматировании кода он все равно переводится в нижний регистр - при настройках по умолчанию; да и читать такой код легче, чем состоящий из одних только заглавных букв - хотя это личное мнение).
Сделать имя функции или переменной а) информативным и б) состоящим из одного слова - задача, я думаю, нерешаемая. Придется как-то разделять.
Для имен функций и параметров их вызова примем разделителем знак "-" (минус). Например, my-cool-function; parameter-list; system-variable и т.п.
Для имен локальных переменных - знак "_" (подчеркивание). К примеру, min_point, loc_path и т.д.
Для глобальных переменных выработаем отдельное правило: во-первых, имена таких переменных "обрамляются" специальным символом "*" (звездочка). Не пугайтесь, LISP в AutoCAD подобное допускает. Значащие слова в имени такой переменной разделяем "-".
Для того, чтобы как-то отделять функции, разработанные на этом сайте, надо бы придумать какой-то уникальный идентификатор, который будет ставиться перед именем функции. Например, lispru-. В таком случае my-cool-function превратится в lispru-my-cool-function
Для локальных функций, определенных внутри тела основной функции, префиксом будет fun_. В остальном правила именований функции останутся неизменными. Например, fun_local-function.

Размещено в Код LISP · Метки:



Поделитесь своим мнением


Я не робот.