Соглашение о кодировании. Emacs lisp

Соглашения о кодировании для elisp.

1 Соглашение об именовании

• В соглашениях об именовании emacs lisp следует обычным правилам именования (см. Соглашения о кодировании).
  • В названиях функций используются только дефисы (например, package-prefix-function-name).
  • Косая черта используется для разделения имени пакета и функции (например, package-prefix/function-name), является популярным нестандартным соглашением.
  • Обычно имена предикатных функций заканчиваются на -p.
  • Имена предикатных функций могут заканчиваться на ? (как в Scheme, Racket Lisp, ruby, clojure) вместо p. Поскольку вопросительный знак более интуитивно понятен, его легче идентифицировать и его можно синтаксически проверить¹.
  • Двойное тире для внутренних методов (вспомогательных функций) является неявным соглашением.
  • Переменная, начинающаяся с подчёркивания _ - неиспользуемая переменная² (неявное соглашение).
  • Соглашение GNU emacs об использовании ALLCAPS для параметров.

2 Внешние ссылки

• A community-driven Emacs Lisp style guide