编程风格 | Coding Style
Coding Style
这些是Electron编码的风格指南。
您可以运行npm run lint
以显示由cpplint
和检测到的任何样式问题eslint
。
C++ 和 Python
对于C ++和Python,我们遵循Chromium的编码风格。您可以使用clang格式自动格式化C ++代码。还有一个脚本script/cpplint.py
来检查所有文件是否符合。
我们现在使用的Python版本是Python 2.7。
C ++代码使用了很多Chromium的抽象和类型,所以建议熟悉它们。Chromium的重要抽象和数据结构文档是一个很好的起点。该文件提到了一些特殊类型,范围类型(当超出范围时会自动释放内存),日志记录机制等。
JavaScript
- 编写标准的 JavaScript风格。
命名事物
Electron API使用与Node.js相同的大小写方案:
- 当模块本身是一个类时
BrowserWindow
,使用CamelCase
。
创建新API时,最好使用getter和setter,而不要使用jQuery的单功能样式。例如,.getText()
并且.setText(text)
更喜欢.text([text])
。有关于此的讨论。