首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

编程风格 | 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风格。
  • 文件名应该连接-而不是_,例如,file-name.js而不是file_name.js,因为在github / atom模块名称通常是在module-name表单中。此规则仅适用于.js文件。
  • 在适当的地方使用更新的ES6 / ES2015语法

命名事物

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

  • 当模块本身是一个类时BrowserWindow,使用CamelCase
  • 当模块是一组API时,就像globalShortcut使用一样mixedCase
  • 当API是对象的一个​​属性时,它足够复杂,可以在单独的章节中win.webContents使用mixedCase
  • 对于其他非模块API,请使用自然标题,例如<webview> TagProcess Object

创建新API时,最好使用getter和setter,而不要使用jQuery的单功能样式。例如,.getText()并且.setText(text)更喜欢.text([text])。有关于此的讨论

扫码关注腾讯云开发者

领取腾讯云代金券