1. Coding Style

原文:https://github.com/electron/electron/blob/master/docs/development/coding-style.md
譯者:Lin

這里有一些在Electron中的編碼風格指導欠气。

你可以運行npm run lint來展示任何風格 to show any style issues detected by cpplinteslint.

<h2 id="cpp-and-python">C++和Python</h2>

對于C++和Python,我們遵循Chromium的代碼風格屠凶。你可以使用clang-format自動格式化C++代碼。這里有一個腳本script/cpplint.py來檢查是否所有的文件都遵循莹弊。

Python的版本我們現(xiàn)在使用的是Python 2.7谴咸。

C++代碼使用了大量的Chromium的抽象類,所以建議了解一下它們笤妙。一個好的開始是Chromium的Important Abstractions and Data Structures文檔硅则。這個文檔中提到一些特殊的類型淹父,作用域類型(當在作用域范圍之外時自動釋放內(nèi)存),以及日志記錄機制等怎虫。

<h2 id="javascript">JavaScript</h2>

  • 寫標準的JavaScript風格暑认。
  • 文件名字應該是使用-連在一起的而不是使用_,例如大审,是file-name.js而不是file_name.js穷吮,因為在github/atom模塊中名字通常是module-name構成方式。這個規(guī)則只適用于.js文件饥努。
  • 在適當?shù)牡胤绞褂眯碌腅S6/ES2015語法

<h2 id="naming-things">命名方式</h2>

Electron接口使用和Node.js相同的命名方式:

  • 當模塊自己就是一個類時,例如BrowserWindow酷愧,則使用CamelCase(駝峰命名法)驾诈。
  • 當模塊是一個接口的集合時,例如globalShortcut溶浴,則使用mixedCase乍迄。
  • 當接口是一個對象的屬性,并且足夠復雜到能夠單獨分出一章士败,例如win.webContents闯两,則使用mixedCase褥伴。
  • 對于其他的模塊接口,使用正常的標題漾狼,例如<webview> TagProcess Object重慢。

當創(chuàng)建一個新的接口,最好使用getters和setters來代替jQuery的one-function風格逊躁。例如似踱,.getText().setText(text)就比.text([text])要好。這里有一個關于這個的討論稽煤。

最后編輯于
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末核芽,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子酵熙,更是在濱河造成了極大的恐慌轧简,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,122評論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件匾二,死亡現(xiàn)場離奇詭異哮独,居然都是意外死亡,警方通過查閱死者的電腦和手機假勿,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,070評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來态鳖,“玉大人转培,你說我怎么就攤上這事〗撸” “怎么了浸须?”我有些...
    開封第一講書人閱讀 164,491評論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長邦泄。 經(jīng)常有香客問我删窒,道長,這世上最難降的妖魔是什么顺囊? 我笑而不...
    開封第一講書人閱讀 58,636評論 1 293
  • 正文 為了忘掉前任肌索,我火速辦了婚禮,結果婚禮上特碳,老公的妹妹穿的比我還像新娘诚亚。我一直安慰自己,他們只是感情好午乓,可當我...
    茶點故事閱讀 67,676評論 6 392
  • 文/花漫 我一把揭開白布站宗。 她就那樣靜靜地躺著,像睡著了一般益愈。 火紅的嫁衣襯著肌膚如雪梢灭。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,541評論 1 305
  • 那天,我揣著相機與錄音敏释,去河邊找鬼库快。 笑死,一個胖子當著我的面吹牛颂暇,可吹牛的內(nèi)容都是我干的缺谴。 我是一名探鬼主播,決...
    沈念sama閱讀 40,292評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼耳鸯,長吁一口氣:“原來是場噩夢啊……” “哼湿蛔!你這毒婦竟也來了?” 一聲冷哼從身側響起县爬,我...
    開封第一講書人閱讀 39,211評論 0 276
  • 序言:老撾萬榮一對情侶失蹤阳啥,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后财喳,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體察迟,經(jīng)...
    沈念sama閱讀 45,655評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,846評論 3 336
  • 正文 我和宋清朗相戀三年耳高,在試婚紗的時候發(fā)現(xiàn)自己被綠了扎瓶。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,965評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡泌枪,死狀恐怖概荷,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情碌燕,我是刑警寧澤误证,帶...
    沈念sama閱讀 35,684評論 5 347
  • 正文 年R本政府宣布,位于F島的核電站修壕,受9級特大地震影響愈捅,放射性物質發(fā)生泄漏。R本人自食惡果不足惜慈鸠,卻給世界環(huán)境...
    茶點故事閱讀 41,295評論 3 329
  • 文/蒙蒙 一蓝谨、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧青团,春花似錦像棘、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,894評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至胖腾,卻和暖如春烟零,著一層夾襖步出監(jiān)牢的瞬間瘪松,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,012評論 1 269
  • 我被黑心中介騙來泰國打工锨阿, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留宵睦,地道東北人。 一個月前我還...
    沈念sama閱讀 48,126評論 3 370
  • 正文 我出身青樓墅诡,卻偏偏與公主長得像壳嚎,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子末早,可洞房花燭夜當晚...
    茶點故事閱讀 44,914評論 2 355

推薦閱讀更多精彩內(nèi)容