Spec-Zone.ru › Wagtail

Общие рекомендации по кодированию

Язык

Для текстов, ориентированных на пользователя, предпочтительно использовать британский английский; этот текст также должен быть помечен для перевода (например, с помощью функции django.utils.translation.gettext и тега шаблона {% trans %}). Однако идентификаторы в коде должны использовать американский английский, если британское или международное написание конфликтуют с ключевыми словами встроенного языка; например, код CSS должен последовательно использовать написание color, чтобы избежать несоответствий, таких как background-color: $colour-red.

Латинские фразы и аббревиатуры

Старайтесь избегать латинских фраз (таких как ergo или de facto) и аббревиатур (таких как i.e. или e.g.), и используйте вместо них обычные английские фразы. В противном случае найдите более простой способ донести концепцию или идею до читателя. Исключение составляет etc., которое можно использовать при ограниченном пространстве.

Примеры:

Не использовать

Использовать вместо этого

e.g.

например, такой как

i.e.

то есть

viz.

именно

ergo

следовательно

Имена файлов

По возможности старайтесь придерживаться существующей схемы именования файлов в той папке, куда добавлены.

Примеры:

  • Шаблоны Django - lower_snake_case.html
  • Документация - lower_snake_case.md

© 2014-present Torchbox Ltd and individual contributors.
All rights are reserved.
Licensed under the BSD License.
https://docs.wagtail.org/en/stable/contributing/general_guidelines.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API