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