This commit is contained in:
Hailin Tseng 2016-01-21 00:03:41 +08:00
Родитель af3def91f2
Коммит f1ef24b359
1 изменённых файлов: 10 добавлений и 17 удалений

Просмотреть файл

@ -1,30 +1,23 @@
# 编码规范
以下是 Electron 项目中代码书写规范的指导方针
以下是 Electron 项目的编码规范
## C++ 和 Python
对于 C++ 和 Python我们追随 Chromium 的[Coding
Style](http://www.chromium.org/developers/coding-style)。你可以通过 `script/cpplint.py` 来检验所有文件是否符合要求。
对于 C++ 和 Python我们遵循 Chromium 的[编码规范](http://www.chromium.org/developers/coding-style)。你可以使用 `script/cpplint.py` 来检验文件是否符合要求。
我们使用的 Pyhton 版本是 Python 2.7。
我们目前使用的 Pyhton 版本是 Python 2.7。
其中 C++ 代码中用到了许多 Chromium 的抽象和类型,我们希望你对其有所熟悉。一个好的去处是
Chromium 的[重要的抽象和数据结构](https://www.chromium.org/developers/coding-style/important-abstractions-and-data-structures)。这个文档提到了一些特殊的类型、域内类型(当超出作用域时会自动释放内存)、日志机制等等。
C++ 代码中用到了许多 Chromium 中的接口和数据类型所以希望你能熟悉它们。Chromium 中的[重要接口和数据结构](https://www.chromium.org/developers/coding-style/important-abstractions-and-data-structures)就是一篇不错的入门文档,里面提到了一些特殊类型、域内类型(退出作用域时自动释放内存)、日志机制,等等。
## CoffeeScript
对于 CoffeeScript我们追随 GitHub 的[Style
Guide](https://github.com/styleguide/javascript) 及如下规则:
对于 CoffeeScript我们遵循 GitHub 的[编码规范](https://github.com/styleguide/javascript) 及以下规则:
* 文件不应该以换行结尾,因为我们要匹配 Google 的规范。
* 文件名应该以 `-` 作连接而不是 `_`,等等。
`file-name.coffee` 而不是 `file_name.coffee`,因为在
[github/atom](https://github.com/github/atom) 模块名通常都是 `module-name` 的形式。这条规则仅应用于 `.coffee` 文件。
* 文件**不要**以换行符结尾,我们要遵循 Google 的编码规范。
* 文件名使用 `-` 而不是 `_` 来连接单词,比如 `file-name.coffee` 而不是 `file_name.coffee`,这是沿用 [github/atom](https://github.com/github/atom) 模块的命名方式(`module-name`)。这条规则仅适用于 `.coffee` 文件。
## API 名
## API 命名
当新建一个API时我们应该倾向于 getters 和 setters 的方式,而不是
jQuery 的单函数形式。例如,`.getText()` 和 `.setText(text)`
优于 `.text([text])`。这里是相关的
[讨论记录](https://github.com/atom/electron/issues/46)。
当新建一个 API 时,我们倾向于使用 getters 和 setters 而不是 jQuery 单函数的命名方式,比如 `.getText()``.setText(text)`
而不是 `.text([text])`。这里有关于该规则的[讨论记录](https://github.com/atom/electron/issues/46)。