При разработке компонентов платформы Flexberry команда должна придерживаться единого стиля написания кода.

Для понимания требований к инфраструктуре приложений рекомендуется ознакомиться с книгой Инфраструктура программных проектов. Соглашения, идиомы и шаблоны для многократно используемых библиотек .NET (+ CD-ROM).

JavaScript

В JavaScript Open Source-проектах платформы Flexberry есть принятый набор соглашений, который опубликован на странице GitHub. Также есть отдельное соглашение по написанию комментариев в коде EmberJS-проектов.

CSharp

Рекомендуется ознакомиться с книгой Инфраструктура программных проектов: соглашения, идиомы и шаблоны для многократно используемых библиотек .NET, в которой описаны лучшие практики, касающиеся как оформления кода, так и архитектурных моментов.
В .NET Open Source-проектах платформы Flexberry набор соглашений реализуется за счёт механизма “Наборов правил”, который присутсвует в Microsoft Visual Studio - следование данным подсказкам IDE позволяет разрабатывать приложения с четким и понятным программным кодом.

Статические анализаторы кода

StyleCop

StyleCop — статический анализатор C# кода на предмет соответствия стилю.

Настройка:

  1. Установить NuGet пакет StyleCop.Analyzers
  2. В свойствах проекта, во вкладке Code Analysis выбрать правила в выпадающем списке Run this rule set.

Стиль кода

С перечнем правил, которые используются в проектах платформы Flexberry можно ознакомится на GitHub-e.

JSLint

JSLint — это статический анализатор кода для программ на языке JavaScript, проверяющий их соответствие стандартам оформления кода.

Настройка:

  1. Установить npm пакет ember-cli-eslint
  2. В корне проекта создать и настроить файл .eslintrc.js, пример реализации содержится в проекте ember-flexberry.
  3. В корне проекта создать файл .eslintignore - в него нужно добавить файлы и дериктории которые не должны проверятся JSLint-ом. Пример реализации содержится в проекте ember-flexberry.

Более подробную информацию можно найти на официальном сайте JSLint

JSHint

JSHint - это инструмент статического анализа кода, используемый при разработке программного обеспечения для проверки соответствия исходного кода JavaScript правилам кодирования.

Настройка:

  1. Установить npm пакет jshint в ember приложениях этот пакет устанавливается в качестве зависимости при установки ember-cli-qunit.
  2. В корне проекта создать и настроить файл .jshintrc, пример реализации содержится в проекте ember-flexberry.