doc调整

api.md

@@ -13,11 +13,11 @@
 **Kind**: global class  
 **Properties**
 
-| Name | Type | Description |
-| --- | --- | --- |
-| ruleItems | <code>Array.&lt;ruleItem&gt;</code> | <p>验证规则</p> |
-| addRuleItem | <code>function</code> | <p>添加一条验证规则</p> |
-| verify | <code>function</code> | <p>检查表单是否符合规则</p> |
+| Name        | Type                                | Description       |
+|-------------|-------------------------------------|-------------------|
+| ruleItems   | <code>Array.&lt;ruleItem&gt;</code> | <p>验证规则</p>       |
+| addRuleItem | <code>function</code>               | <p>添加一条验证规则</p>   |
+| verify      | <code>function</code>               | <p>检查表单是否符合规则</p> |
 
 
 * [FieldCheck](#FieldCheck)
@@ -37,7 +37,32 @@
 
 **Example**  
 ```js
-let fieldCheck = new FieldCheck();
fieldCheck.addRuleItem('rule1',['name'],[
   {
   type: 'string',
   minLength: 2,
   maxLength: 10,
   message: '姓名必须为2-10个字符'
   }
   ]);
   fieldCheck.addRuleItem('rule2',['age'],[
   {
   type: 'number',
   min: 18,
   max: 100,
   message: '年龄必须为18-100岁'
   }]);
   let errMsg = fieldCheck.verify({
   name: 'kindring',
   age: 18});
   console.log(errMsg);
   // null
   let errMsg = fieldCheck.verify({
   name: 'kindring',
   age: 17});
   console.log(errMsg);
   // 年龄必须为18-100岁
+let fieldCheck = new FieldCheck();
+fieldCheck.addRuleItem('rule1',['name'],[
+   {
+   type: 'string',
+   minLength: 2,
+   maxLength: 10,
+   message: '姓名必须为2-10个字符'
+   }
+   ]);
+   fieldCheck.addRuleItem('rule2',['age'],[
+   {
+   type: 'number',
+   min: 18,
+   max: 100,
+   message: '年龄必须为18-100岁'
+   }]);
+   let errMsg = fieldCheck.verify({
+   name: 'kindring',
+   age: 18});
+   console.log(errMsg);
+   // null
+   let errMsg = fieldCheck.verify({
+   name: 'kindring',
+   age: 17});
+   console.log(errMsg);
+   // 年龄必须为18-100岁
 ```
 <a name="FieldCheck+_isEmpty"></a>
 
@@ -46,9 +71,9 @@ let fieldCheck = new FieldCheck();
fieldCheck.addRuleItem('rule1',['name'],[
 
 **Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
 
-| Param | Description |
-| --- | --- |
-| v | <p>要检验的值</p> |
+| Param | Description  |
+|-------|--------------|
+| v     | <p>要检验的值</p> |
 
 <a name="FieldCheck+_isRegExp"></a>
 
@@ -57,9 +82,9 @@ let fieldCheck = new FieldCheck();
fieldCheck.addRuleItem('rule1',['name'],[
 
 **Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
 
-| Param | Description |
-| --- | --- |
-| v | <p>要检验的值</p> |
+| Param | Description  |
+|-------|--------------|
+| v     | <p>要检验的值</p> |
 
 <a name="FieldCheck+buildRuleItem"></a>
 
@@ -69,10 +94,10 @@ let fieldCheck = new FieldCheck();
fieldCheck.addRuleItem('rule1',['name'],[
 **Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
 **Returns**: <code>ruleItem</code> - <p>验证规则对象</p>  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| checkFields | <code>Array.&lt;(string\|RegExp)&gt;</code> | <p>需要验证的字段</p> |
-| ruleArr | <code>Array.&lt;(validatorFunction\|checkRule)&gt;</code> | <p>验证规则</p> |
+| Param       | Type                                                      | Description    |
+|-------------|-----------------------------------------------------------|----------------|
+| checkFields | <code>Array.&lt;(string\|RegExp)&gt;</code>               | <p>需要验证的字段</p> |
+| ruleArr     | <code>Array.&lt;(validatorFunction\|checkRule)&gt;</code> | <p>验证规则</p>    |
 
 <a name="FieldCheck+addRuleItem"></a>
 
@@ -82,11 +107,11 @@ let fieldCheck = new FieldCheck();
fieldCheck.addRuleItem('rule1',['name'],[
 **Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
 **Returns**: <p>返回当前对象</p>  
 
-| Param | Description |
-| --- | --- |
-| ruleName | <p>验证规则名,用于区分</p> |
+| Param       | Description            |
+|-------------|------------------------|
+| ruleName    | <p>验证规则名,用于区分</p>      |
 | checkFields | <p>用于匹配字段的字符或者正则数组</p> |
-| ruleArr | <p>验证规则</p> |
+| ruleArr     | <p>验证规则</p>            |
 
 <a name="FieldCheck+getRuleItem"></a>
 
@@ -97,8 +122,8 @@ let fieldCheck = new FieldCheck();
fieldCheck.addRuleItem('rule1',['name'],[
 **Returns**: <p>验证规则</p>  
 
 | Param | Description |
-| --- | --- |
-| field | <p>字段名</p> |
+|-------|-------------|
+| field | <p>字段名</p>  |
 
 <a name="FieldCheck+checkField"></a>
 
@@ -109,9 +134,9 @@ let fieldCheck = new FieldCheck();
fieldCheck.addRuleItem('rule1',['name'],[
 **Returns**: <code>Array.&lt;(checkCode\|?errMessage)&gt;</code> - <p>错误码或错误信息</p>  
 
 | Param | Description |
-| --- | --- |
-| field | <p>字段名</p> |
-| value | <p>字段值</p> |
+|-------|-------------|
+| field | <p>字段名</p>  |
+| value | <p>字段值</p>  |
 
 <a name="FieldCheck+verify"></a>
 
@@ -121,10 +146,10 @@ let fieldCheck = new FieldCheck();
fieldCheck.addRuleItem('rule1',['name'],[
 **Kind**: instance method of [<code>FieldCheck</code>](#FieldCheck)  
 **Returns**: <p>errMessage 错误码或错误信息</p>  
 
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| formObject | <code>verifyForm</code> |  | <p>需要检验的表单项 字段:值</p> |
-| [isMustMatch] |  | <code>false</code> | <p>是否强制要求匹配规则</p> |
+| Param         | Type                    | Default            | Description          |
+|---------------|-------------------------|--------------------|----------------------|
+| formObject    | <code>verifyForm</code> |                    | <p>需要检验的表单项 字段:值</p> |
+| [isMustMatch] |                         | <code>false</code> | <p>是否强制要求匹配规则</p>    |
 
 <a name="FormVerify"></a>
 
@@ -144,15 +169,15 @@ let fieldCheck = new FieldCheck();
fieldCheck.addRuleItem('rule1',['name'],[
 
 <a name="new_FormVerify_new"></a>
 
-### new FormVerify(formObject, [fieldCheck], [option])
+### `new FormVerify(formObject, [fieldCheck], [option])`
 <p>表单项</p>
 
 
-| Param | Type | Description |
-| --- | --- | --- |
-| formObject | <code>formObject</code> | <p>表单项数据</p> |
+| Param        | Type                                   | Description   |
+|--------------|----------------------------------------|---------------|
+| formObject   | <code>formObject</code>                | <p>表单项数据</p>  |
 | [fieldCheck] | [<code>FieldCheck</code>](#FieldCheck) | <p>字段验证对象</p> |
-| [option] | <code>object</code> | <p>配置项</p> |
+| [option]     | <code>object</code>                    | <p>配置项</p>    |
 
 <a name="FormVerify+checkForm"></a>
 
@@ -161,10 +186,10 @@ let fieldCheck = new FieldCheck();
fieldCheck.addRuleItem('rule1',['name'],[
 
 **Kind**: instance method of [<code>FormVerify</code>](#FormVerify)  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| form | <code>formObject</code> | <p>表单对象</p> |
-| isMustMatch |  | <p>是否必须全部匹配到验证规则</p> |
+| Param       | Type                    | Description          |
+|-------------|-------------------------|----------------------|
+| form        | <code>formObject</code> | <p>表单对象</p>          |
+| isMustMatch |                         | <p>是否必须全部匹配到验证规则</p> |
 
 <a name="FormVerify+check"></a>
 
@@ -173,8 +198,8 @@ let fieldCheck = new FieldCheck();
fieldCheck.addRuleItem('rule1',['name'],[
 
 **Kind**: instance method of [<code>FormVerify</code>](#FormVerify)  
 
-| Param | Default | Description |
-| --- | --- | --- |
+| Param         | Default            | Description          |
+|---------------|--------------------|----------------------|
 | [isMustMatch] | <code>false</code> | <p>是否必须全部匹配到验证规则</p> |
 
 <a name="FormVerify.buildFormItem"></a>
@@ -185,12 +210,12 @@ let fieldCheck = new FieldCheck();
fieldCheck.addRuleItem('rule1',['name'],[
 **Kind**: static method of [<code>FormVerify</code>](#FormVerify)  
 **Returns**: <p>errMsg 错误信息</p>  
 
-| Param | Description |
-| --- | --- |
-| object | <p>表单项数据</p> |
-| field | <p>字段名</p> |
-| formItemData | <p>表单项数据</p> |
-| fieldCheck | <p>字段验证对象</p> |
+| Param           | Description            |
+|-----------------|------------------------|
+| object          | <p>表单项数据</p>           |
+| field           | <p>字段名</p>             |
+| formItemData    | <p>表单项数据</p>           |
+| fieldCheck      | <p>字段验证对象</p>          |
 | isMustMatchRule | <p>表单字段是否必须匹配到验证规则</p> |
 
 <a name="FormVerify.initFormItemData"></a>
@@ -200,7 +225,7 @@ let fieldCheck = new FieldCheck();
fieldCheck.addRuleItem('rule1',['name'],[
 
 **Kind**: static method of [<code>FormVerify</code>](#FormVerify)  
 
-| Param | Type | Description |
-| --- | --- | --- |
+| Param      | Type                    | Description |
+|------------|-------------------------|-------------|
 | formObject | <code>formObject</code> | <p>表单对象</p> |