对于代码，解析器会根据注释内容提取出相应信息，形成文档页面。

现在支持的注释形式如下：

关于参数表述内版本

可以用以下形式标识：

  • 从 1.0.0 开始支持： {add:1.0.0} 或 <1.0.0>
  • 在 1.0.0 添加，2.0.0版本删除： {add:1.0.0}{del:2.0.0} 或 <1.0.0,2.0.0>

JS-Library

每个代码块可以用这样一个注释块。

/**
 * 打开
 *
 * @method XXX.router.open
 * @alias XXX.open
 * @category Router
 * @version 1.0.0
 * @param {String} name 视图名 <1.0.0>
 * @returns {Object} 东西
 * @example
 * XXX.open('view', {
 *     param: {
 *         x: 1,
 *         y: 2
 *     },
 *     ani: 'moveEnter',
 * });
 * @description
 * *open* 主要用于切换视图，类似于PC端的跳转，近似于App上的切换视图操作。
 */

参数说明

啪啦啪啦啪啦。。。后续有调整，所以这个说明正式版再说啦。

JS-Component

每个组件的代码在一个文件内，一个包含 @component 标签的注释块为组件说明，数个包含 @property 标签的注释块为配置属性，数个包含 @method 标签的注释块为实例方法。

/**
 * 滚动组件
 *
 * @component ScrollView
 * @example ./Playground/js/Examples/ScrollViewExample/vertical&horizontal.js[1-77]
 * @version >=0.20.0
 * @description 一个包装了平台的ScrollView（滚动视图）的组件，同时还集成了触摸锁定的“响应者”系统。
 *
 * * 记住ScrollView必须有一个确定的高度才能正常工作，因为它实际上所做的就是将一系列不确定高度的子组件装进一个确定高度的容器（通过滚动操作）。
 * * 要给一个ScrollView确定一个高度的话，要么直接给它设置高度（不建议），要么确定所有的父容器都已经绑定了高度。
 * * 在视图栈的任意一个位置忘记使用{flex:1}都会导致错误，你可以使用元素查看器来查找问题的原因。
 *
 * ![ScrollView](./images/ScrollView.png)
 */

/**
 * 内容位移
 *
 * @property contentInset
 * @type EdgeInsetsPropType
 * @default {top: 0, left: 0, bottom: 0, right: 0}
 * @description 内容范围相对滚动视图边缘的坐标。
 */

/**
 * 滚动到
 *
 * @method scrollTo
 * @param {PointPropType{x:x,y:y}} offset 滚动到的位置
 * @description 滚动到某一位置，如果只在某一方向滚动，可以只传{x: x}或{y: y}。
 */

参数说明

同上

CSS-Library

每个代码块可以用这样一个注释块。

/**
 * @module fragment
 * @method yo-list
 * @version 1.0.0
 * @description 构造列表的自定义使用方法
 * @demo http://doyoe.github.io/Yo/demo/fragment/yo-list.html
 * @example ./examples/fragment/yo-list.sccs[5-48]
 * @param {Color} $on-color 子项选中文本色 {add:1.4.0}
 * @param {Boolean} $has-last-border 是否有最后一根底边线，改由`border-width`参数控制 {add:2.1.0}{del:2.1.3}
 * @param {Color} $item-bordercolor 子项边框色 <1.2.0,2.0.0>
 * @param {Color} $item-border-color 子项边框色 <2.0.0>
 * @skip
 */

标签说明

  • module: 模块名（分类）
  • method: 方法名
  • version: 版本
  • demo: demo 地址
  • example: example 代码，文件路径[起始位置-结束位置] 或者直接写 源代码
  • param: 参数，格式为：{类型} 名称 描述
  • skip: 跳过此注释块