本文整理自网络,侵删。
标题
- 每个页面顶部必须有一个单独的
#
级标题。 - 同一页面中的章节必须有
##
级标题。 - 子章节需要根据它们的嵌套深度增加标题中的
#
数量。 - 页面标题中的所有单词首字母都必须大写,除了 “of” 和 “and” 之类的连接词。
- 只有章节标题的第一个单词首字母必须大写.
举一个 Quick Start
的例子:
# Quick Start ... ## Main process ... ## Renderer process ... ## Run your app ... ### Run as a distribution ... ### Manually downloaded Electron binary ...
对于 API 参考, 可以例外于这些规则.
Markdown 规则
- 在代码块中使用
bash
而不是cmd
(由于语法高亮问题). - 行长度应该控制在80列内.
- 列表嵌套不超出2级 (由于 Markdown 渲染问题).
- 所有的
js
和javascript
代码块均被标记为 standard-markdown.
用词选择
- 在描述结果时,使用 “will” 而不是 “would”。
- 首选 "in the ___ process" 而不是 "on".
API 参考
以下规则仅适用于 API 的文档。
页面标题
每个页面必须使用由 require('electron')
返回的实际对象名称作为标题,例如 BrowserWindow
,autoUpdater
和 session
。
在页面标题下必须是以 >
开头的单行描述。
举一个 session
的例子:
# session > Manage browser sessions, cookies, cache, proxy settings, etc.
模块方法和事件
对于非类的模块,它们的方法和事件必须在 ## Methods
和 ## Events
章节中列出。
举一个 autoUpdater
的例子:
# autoUpdater ## Events ### Event: 'error' ## Methods ### `autoUpdater.setFeedURL(url[, requestHeaders])`
类
- API 类或作为模块一部分的类必须在
## Class: TheClassName
章节中列出. - 一个页面可以有多个类.
- 构造函数必须用
###
级标题列出. - 静态方法 必须在
### Static Methods
章节中列出. - 实例方法 必须在
### Instance Methods
章节中列出. - 所有具有返回值的方法必须用 "Returns
[TYPE]
- Return description" 的形式描述.- 如果该方法返回一个
Object
,则可以使用冒号后跟换行符,然后使用与函数参数相同样式的属性的无序列表来指定其结构.
- 如果该方法返回一个
- 实例事件必须在
### Instance Events
章节中列出. - 实例属性必须在
### Instance Properties
章节中列出.- 实例属性必须以 "A [Property Type] ..." 开始描述.
这里用 Session
和 Cookies
类作为例子:
# session ## Methods ### session.fromPartition(partition) ## Properties ### session.defaultSession ## Class: Session ### Instance Events #### Event: 'will-download' ### Instance Methods #### `ses.getCacheSize(callback)` ### Instance Properties #### `ses.cookies` ## Class: Cookies ### Instance Methods #### `cookies.get(filter, callback)`
方法
方法章节必须采用以下形式:
### `objectName.methodName(required[, optional]))` * `required` String - A parameter description. * `optional` Integer (optional) - Another parameter description. ...
标题可以是 ###
级别或 ####
级别,具体取决于它是模块还是类的方法。
相关阅读 >>
Electron headless ci systems 测试 (travis ci, jenkins)
更多相关阅读请进入《Electron》频道 >>

Vue.js 设计与实现 基于Vue.js 3 深入解析Vue.js 设计细节
本书对 Vue.js 3 技术细节的分析非常可靠,对于需要深入理解 Vue.js 3 的用户会有很大的帮助。——尤雨溪,Vue.js作者