<commit_before>文档规范
====

示例文档见 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 关键字。


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


名称约定
----
### 变量类型

1. 源生对象 DOMElement
2. Neuron DOM 对象 NeuronDOM
3. 


<commit_msg>update docs<commit_after>文档规范
====

示例文档见 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 关键字。


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


名称约定
----
### 变量类型

1. 源生对象 DOMElement
2. Neuron DOM 对象 NeuronDOM
3. 



{'fraction_non_alphanumeric': 0.17257318952234207, 'fraction_numerical': 0.020030816640986132, 'mean_word_length': 3.775735294117647, 'pattern_counts': {'":': 0, '<': 17, '<?xml version=': 0, '>': 17, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6865571', 'n_tokens_mistral': 979, 'n_tokens_neox': 1045, 'n_words': 127}