书写元素文档

在帖子里给出以下三个部分内容

  • 元素详情json,书写格式
  • 元素使用方式描述
  • 导出示例

书写格式

元素详情json

带注释的元素详细信息示例:

{
  "name": "元素名称", // 元素名称
  "description": "元素描述", // 元素描述
  "veision": "0.0.1", // 版本号
  "tag": [{ // 标签(关键字)
    "name": "数据"
  }],
  "spppc": true, // 是否支持pc true支持 false不支持 未知留空
  "spphone": true, // 是否支持手机浏览器
  "sppandroidapp": true, // 是否支持安卓app
  "sppiosapp": true, // 是否支持iosapp
  "sppwechat": true, // 是否微信浏览器支持
  "author": "zhanglinling", // 元素作者, 以运行期为准
  "authorbz": "作者备注", // 作者备注
  "wwcname": "fetchdata", // 特殊元素标识
  "wwcnamebz": "", // 特殊元素标识备注
  "ckedit": true, // 编辑器支持
  "runedit": true, // 运行期支持
  "tplcompileredit": true, // 编译器支持
  "otheres": "无额外资源", // 额外资源描述
  "createtime": "2016-09-09T16:00:00.000Z", // 元素创建时间, ios格式的utc时间
  "latetime": "2016-09-09T16:00:00.000Z", // 元素最近更新时间, 支撑更新, 不是手册更新, ios格式的utc时间
  "attr": [{ // 普通属性
    "name": "data-asyn", // 属性名
    "ms": "描述", // 属性描述
    "sl": "示例" // 属性值示例
  }],
  "evtin": [{ // 控制属性
    "name": "data--sync",
    "ms": "描述",
    "sl": "示例"
  }],
  "scattr": [{ // 输出属性
    "name": "data-x-pg",
    "ms": "描述",
    "sl": "示例"
  }],
  "evtlisten": [ // 监听事件
    {
      "name": "事件名",
      "ms": "描述",
      "data": "事件带着的数据"
    }
  ],
  "evttrigger": [ // 发出事件
    {
      "name": "事件名",
      "ms": "描述",
      "data": "事件带着的数据"
    }
  ]
}
{"name":"录音元素","description":"用于录音","veision":"0.0.1","tag":[{"name":"录音"}],"spppc":false,"spphone":false,"sppandroidapp":true,"sppiosapp":"","sppwechat":false,"author":"zhanglinling","authorbz":"","wwcname":"record","wwcnamebz":"","ckedit":false,"runedit":true,"tplcompileredit":false,"otheres":"无额外资源","createtime":"2017-03-06T16:00:00.000Z","latetime":"2017-03-06T16:00:00.000Z","attr":[{"name":"属性名","ms":"描述","sl":"示例"}],"evtin":[{"name":"属性名","ms":"描述","sl":"示例"}],"scattr":[{"name":"属性名","ms":"描述","sl":"示例"}],"evtlisten":[{"name":"事件名","ms":"描述","data":"事件带着的数据"}],"evttrigger":[{"name":"事件名","ms":"描述","data":"事件带着的数据"}]}

在线编辑json工具​点击查看