Стиль кодирования

Эти руководства по стилю кодирования предназначены для разработки в Electron.

Вы можете запустить npm run lint, чтобы показать любые проблемы со стилем, обнаруженные cpplint и eslint.

C++ и Python

Для C++ и Python мы следуем руководствам по стилю кодирования Chromium Coding Style. Вы можете использовать clang-format для автоматического форматирования C++ кода. Также есть скрипт script/cpplint.py для проверки соответствия всех файлов.

Текущая версия Python, которую мы используем, — это Python 2.7.

C++ код использует много абстракций и типов Chromium, поэтому рекомендуется ознакомиться с ними. Хорошим местом для начала является документ Chromium Important Abstractions and Data Structures. Документ упоминает некоторые специальные типы, обобщённые типы (которые автоматически освобождают память при выходе из области видимости), механизмы логирования и т.д.

JavaScript* Пишите стандартный стиль JavaScript.

• Имена файлов должны быть объединены с помощью - вместо _, например, file-name.js вместо file_name.js, так как в github/atom имена модулей обычно имеют форму module-name. Это правило применимо только к файлам с расширением .js.
• Используйте более новые синтаксисы ES6/ES2015 там, где это уместно
  • const для require и других констант
  • let для определения переменных
  • Стрелочные функции вместо function () { }
  • Шаблонные литералы вместо конкатенации строк с помощью +## Именование вещей

API Electron использует ту же схему заглавных букв, что и Node.js:

• Когда модуль сам является классом, например BrowserWindow, используйте CamelCase.
• Когда модуль представляет собой набор API, например globalShortcut, используйте mixedCase.
• Когда API является свойством объекта и достаточно сложным, чтобы быть отдельной главой, например win.webContents, используйте mixedCase.
• Для других не-модульных API используйте естественные заголовки, например <webview> Tag или Process Object. При создании новой API рекомендуется использовать getters и setters вместо стиля одной функции из jQuery. Например, предпочтительнее использовать .getText() и .setText(text) вместо .text([text]). На этот счет есть обсуждение.