Previous: Типы данных и поиск образцов, Up: Стиль кодирования [Contents][Index]
При написании кода Scheme мы пользуемся мудростью программистов Scheme. В основном мы следуем Riastradh’s Lisp Style Rules. Этот документ, к счастью, содержит большинство соглашений, которые применимы также для кода Guile. Это очень вдумчиая работа, пожалуйста, прочтите её.
Некоторые специальные формы, вводимые в Guix, как например, макрос
substitute*
, имеют специальные правила отступов. Они определены в
файле .dir-locals.el, которые использует Emacs автоматически. Также
отметим, что Emacs-Guix предоставляет режим guix-devel-mode
, который
вставляет отступы и подсвечивает код Guix должным образом
(see Development in The Emacs-Guix Reference Manual).
Если вы не пользуетесь Emacs, пожалуйста убедитесь, что ваш редактор знает эти правила. Для автоматической расстановки отступов можно запустить:
./pre-inst-env guix style package
See Invoking guix style
, for more information.
Если вы редактируете код в Vim, мы рекомендуем запустить :set
autoindent
, так отступы будут автоматически вставляться в ваш код, пока вы
печатаете. В дополнение вам может помочь для работы со всеми этими скобками
paredit.vim
.
Мы требуем, чтобы все высокоуровневые процедуры содержали строки
документации. Хотя это требование может не учитываться для простых приватных
процедур в пространстве имён (guix build …)
.
Процедуры должны иметь не более четырёх параметров. Передавайте параметры по ключевым словам в процедурах, которые принимают более четырёх параметров.