rsp技术开发规范总结.docVIP

终 端RSP 开 发 规 范 2010-3-4 目 录 一、StoryBoard规范 4 1、 场景描述规范 4 2、 Service Tree规范 4 二、 命名规范 4 1、 RSP命名规范 4 2、 元素节点命名规范 4 3、 RSP中Java代码命名规范 5 4、 切图图片命名规范 5 三、 注释规范 5 1、 RSP文件注释 5 2、 RSP节点注释 5 3、 业务条件注释 6 四、 开发框架规范 6 1、 目录规范 6 2、 RSP框架规范 6 3、 屏幕适配框架使用规范 10 4、 Cache使用规范 13 5、 CacheObject使用规范 14 一、StoryBoard规范 场景描述规范 描述场景功能，对每个场景编号，该编号和Service Tree中场景编号对应； 描述场景中各个元素的来源，动画效果和交互效果； Service Tree规范 Service Tree要对没一个业务场景编号，该编号和Story Board的场景编号对应。ServiceTree要反映各个场景的跳转和层次关系，根据此层次关系确定开发框架中的场景级数。 命名规范 RSP命名规范 RSP命名形式：文件所在位置_所属业务_场景名_类型 文件所在位置是指文件是在客户端还是服务器端。在客户端的文件用c表示，在服务器端的文件用s表示； 所属业务是指该文件属于哪个业务模块，比如该页面在客户端，且属于新闻模块则写成：c_news.rsp。业务名全部用英文表示; 场景名是指该rsp所描述对应场景名，场景名用英文表示。如该页面在客户端是新闻模块，描述的是新闻类型则该rsp名是c_news_type.rsp; 类型是指该rsp是View还是Content。比如该页面在客户端，且属于新闻模块且为View则写成：c_news_type_view.rsp;如果该rsp文件既不是View也不是Content则该类型可以不写。 文件名一律小写。 文件编码必须是UTF-8 元素节点命名规范 节点命名形式：节点域_所属业务_场景名_内容描述 节点域，本地用“Local”，全局用“Global”禁止使用简写； 内容描述，由开发人员定义。只要符合能表述清楚该节点的功能或内容的原则就行。内容描述用英文； 节点名称遵循驼峰是命名规则，Global：newsDetail表示新闻明细或者Global：news_detail 其他描述同RSP命名规范。 RSP中Java代码命名规范 RSP中Java代码变量全小写，只要符合能表述清楚该变量的意义的原则皆可。代码编写必须遵循java1.5的规范.遵循匈牙利命名规则. 切图图片命名规范 图片命名形式：图片所在位置_所属业务_内容 图片所在位置是指图片是在客户端还是服务器端。在客户端的图片用c表示，在服务器端的文件用s表示； 所属业务是指该图片属于哪个业务模块，比如该图片在客户端，且属于新闻模块则写成：c_news.png。图片名全部用英文表示; 内容是指对该图片意思的表述，如该图片是按钮按下的图片，在客户端属于新闻模块则写成：c_news_button_down.png 注释规范 RSP文件注释 在每个RSP文件开头要有如下形式的注释： !— 开发人:*** 开发时间:2010-3-4 修改时间: 2010-3-4 --场景描述：描述该RSP属于哪个业务，是哪一个场景 --来源RSP：由哪个RSP进入 --来源参数：参数类型 参数名 -- 参数类型 参数名 --进入RSP：将进入哪个RSP --进入RSP参数：参数类型 参数名 -- 参数类型 参数名 -- RSP节点注释 对RSP文件中的每个节点或节点块头标明该节点对应StoryBoard中的场景或动作效果。如： !--新闻列表-- Transform !--一个Item选中的背景图片-- Use target=Global:news_list_selectedImg/ !--下移选中框的动作-- Action /Action /Transform 业务条件注释 如果由于业务条件的不同，同一个表示区域会有不同的效果或动作则要在条件判断处要标明在什么情况下会进入哪段代码。 开发框架规范 目录规范 目录规范用于说明项目工作区的文档结构，规范文件放置。具体结构如下： src 公用目录 业务组1 子业务1 子业务2… 业务组2 子业务1 子业务2… . . . Res Devices设备配置目录 Layouts 界面布局