交接文档需求

基础库版本

基础库版本:1.6.6
最低支持基础库版本:1.5.0

兼容性

微信:xx以下 || 安卓/IOS xxx 不支持

代码规范及注释

使用xxxxx

1、项目入口配置

自定目录结构说明
{

img:本地图片路径,

utils:工具类,

template:模板

//备注:xxxxxxxxx

..............
}
配置说明
{

"pages/index/index":首页,

"pages/logs/logs":日志

//备注:xxxxxxxxxx

}

2、全局参数及全局方法说明

全局参数
{

token:用户登陆唯一标示

//备注:token保存至本地缓存 Storage 

.............

}
全局方法
{

应用场景:xxxxx,

方法参数:xxxx,

功能简介:xxx方法是用于xxxxx......功能的实现。

//备注:xxxxxxxx

}............

3、功能模块结构说明

例如:首页模块说明

xxx模块名详情
{

index:首页

参数接收:appid 程序唯一标识

是否引用其他模块:是/否

//引用模块名:banner(广告横幅)、public(全局方法)

//备注:xxxxxxxx

}
模块自定义参数名含义
{

name:姓名,

status:xxx状态 {0:是,1:否}

//备注:xxxxxxxx

}
模块跳转详情
{

跳转入口方法名:navigator()

跳转模块名:userCenter(xxx个人中心)

是否传参数: 是/否

//参数名:userID(用户id)

//备注:xxxxxxxx

}
模块自定义方法名及含义
{

    自定义方法一:{

    方法参数:xxxx,

    功能简介:xxx方法是用于xxxxx......功能的实现。

    //备注:xxxxxxxx

    },

    自定义方法二:{

    方法参数:xxxx,

    功能简介:xxx方法是用于xxxxx......功能的实现。

    },..........

}

4、自定义目录功能内容说明(插件、封装等......)

此文档借鉴栏目3

你可能感兴趣的:(交接文档需求)