编码风格

这些是 Electron 中编码的风格指南。

你可以运行 npm run lint 来显示 cpplint 和 eslint 检测到的任何风格问题。

通用代码

• 文件末尾应包含一个换行符。
• 按照以下顺序放置 require
  • 内置 Node 模块（例如 path）
  • 内置 Electron 模块（例如 ipc, app）
  • 本地模块（使用相对路径）
• 按照以下顺序放置类属性
  • 类方法和属性（方法以 @ 开头）
  • 实例方法和属性
• 避免平台相关的代码
  • 使用 path.join() 来连接文件名。
  • 当你需要引用临时目录时，使用 os.tmpdir() 而不是 /tmp。
• 在函数末尾显式返回时使用简单的 return。
  • 不要使用 return null, return undefined, null 或 undefined

C++ 和 Python

对于 C++ 和 Python，我们遵循 Chromium 的 编码风格。 还有一个脚本 script/cpplint.py 可以用来检查所有文件是否符合规范。

我们现在使用的 Python 版本是 Python 3.9。

C++ 代码使用了大量的 Chromium 抽象和类型，因此建议熟悉它们。 一个好的起点是 Chromium 的 重要抽象和数据结构 文档。 该文档提到了某些特殊类型、作用域类型（在超出作用域时自动释放其内存）、日志记录机制等。

文档

• 编写 remark markdown 风格。

你可以运行 npm run lint:docs 来确保你的文档更改格式正确。

JavaScript

• 编写 standard JavaScript 风格。
• 文件名应使用 - 连接，而不是 _，例如 file-name.js 而不是 file_name.js，因为在 atom/atom 模块中，模块名称通常采用 module-name 形式。 此规则仅适用于 .js 文件。
• 在适当的情况下使用较新的 ES6/ES2015 语法
  • const 用于 require 和其他常量。 如果值是原始类型，则使用大写命名（例如 const NUMBER_OF_RETRIES = 5）。
  • let 用于定义变量
  • 箭头函数 代替 function () { }
  • 模板字面量 代替使用 + 进行字符串连接

命名

Electron API 使用与 Node.js 相同的首字母大小写方案

• 当模块本身是一个类，例如 BrowserWindow 时，使用 PascalCase。
• 当模块是一组 API 时，例如 globalShortcut，使用 camelCase。
• 当 API 是对象的属性，并且足够复杂到需要单独成章，例如 win.webContents 时，使用 mixedCase。
• 对于其他非模块 API，使用自然标题，例如 <webview> 标签 或 Process 对象。

创建新的 API 时，建议使用 getter 和 setter，而不是 jQuery 的单函数风格。 例如，.getText() 和 .setText(text) 比 .text([text]) 更好。 有一个 讨论 关于这一点。