代码规范
您可以运行 来显示 cpplint
和eslint
检测到的任何样式问题。
- 用换行符结束文件。
按照如下顺序排列 node 模块的 require 代码
- 内置Node模块(如
path
) - 内置Electron模块(如
ipc
、app
)
- 内置Node模块(如
-
- Class methods and properties (methods starting with a
@
) - Instance methods and properties
- Class methods and properties (methods starting with a
避免与平台相关的代码:
- 使用
path.join()
来组织文件路径。 - 请使用
os.tmpdir()
而不是/tmp
来引用临时目录。
- 使用
使用
return
来明确的结束一个函数- 不是
return null
,,null
或undefined
- 不是
我们现在使用的 Python 版本是 Python 2.7。
C++ 代码使用了大量 Chromium 的抽象和类型,因此建议您熟悉它们。 一个起步的好地方是 Chromium 的 重要的抽象概念和数据库结构 文档. 该文档提到一些特殊类型,范围类型(超出范围时自动释放其内存), 记录机制等。
- 使用 Markdown样式.你可以运行
npm run lint-docs
来保证你修改的文档格式正确。
- 文件名应使用
-
连接而不是_
, 例如.file-name.js
而不是file_name.js
, 因为在 github/atom中模块名通常是module-name
形式. 此规则仅适用于.js
文件。 -
- 用于需要的和其他的常数
- 用于定义变量
- 代替
function () { }
- Template literals 而不是使用字符串连接符
+
Electron API 使用与 Node.js 相同的大小写方案:
- 当模块本身是class时, 比如
BrowserWindow
, 使用CamelCase
. - 当模块是一组 API 时, 比如
globalShortcut
时,使用mixedCase
。 - 当 API 是对象的属性时, 并且它复杂到足以成为一个单独的块, 比如
win.webContents
, 使用mixedCase
.