Electron 編碼規(guī)范

2018-03-17 18:53 更新

以下是 Electron 項(xiàng)目的編碼規(guī)范。

C++ 和 Python

對于 C++ 和 Python,我們遵循 Chromium 的編碼規(guī)范。你可以使用 script/cpplint.py 來檢驗(yàn)文件是否符合要求。

我們目前使用的 Pyhton 版本是 Python 2.7。

C++ 代碼中用到了許多 Chromium 中的接口和數(shù)據(jù)類型,所以希望你能熟悉它們。Chromium 中的重要接口和數(shù)據(jù)結(jié)構(gòu)就是一篇不錯的入門文檔,里面提到了一些特殊類型、域內(nèi)類型(退出作用域時自動釋放內(nèi)存)、日志機(jī)制,等等。

CoffeeScript

對于 CoffeeScript,我們遵循 GitHub 的編碼規(guī)范 及以下規(guī)則:

  • 文件不要以換行符結(jié)尾,我們要遵循 Google 的編碼規(guī)范。
  • 文件名使用 - 而不是 _ 來連接單詞,比如 file-name.coffee 而不是 file_name.coffee,這是沿用 github/atom 模塊的命名方式(module-name)。這條規(guī)則僅適用于 .coffee 文件。

API 命名

當(dāng)新建一個 API 時,我們傾向于使用 getters 和 setters 而不是 jQuery 單函數(shù)的命名方式,比如 .getText()  .setText(text) 而不是 .text([text])。

以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號