56 lines (31 loc) · 1.17 KB

文档规范

示例文档见 SAMPLE.md

API 方法标题

说明在文档中，每一个 API 方法标题的格式。

其中，下文提到的，

<方法名>，首字母必须为小写，仅包含 a-z, A-Z, 0-9。多个单词请使用驼峰（CamelCase）
<模块名>，首字母为大写，仅包含 a-z, A-Z, 0-9。多个单词请使用驼峰（CamelCase）

1. 实例方法

<方法名>()

例如，addAttr 就表示是当前模块的实例上名为 addAttr 的方法。

2. 模块本身就是一个方法

<模块名>()

例如，Hippo

3. 静态方法

<模块名>.<方法名>()

例如，NR.load 指的是一个静态方法

4. 构造器

<模块名>: Constructor

例如，Switch: Constructor，表明下文描述的是模块 Switch 的构造器的使用方法，并默认说明这种用法必须使用 new 关键字。

书写格式

英文字母与中文汉字之间，需要包含一个空格。如：这里是 Neuron 项目的文档规范。
如果在行内包含代码，需要将代码片段使用 ` 扩起。如：new Switch()

名称约定

变量类型

源生对象 DOMElement
Neuron DOM 对象 NeuronDOM