1. 设计原则与组件命名
1.1 设计原则
在现代网页设计中,Widget作为页面中的小组件,其可复用性是开发中的重要考量,良好的组件设计应当保证它可以在不同的页面中被复用,组件的拆分细化程度需要综合业务逻辑和复用概率进行考虑,以实现最优的平衡。
1.2 三段式命名规则
每个Widget的标识应明确且具有可读性,采用三段式命名方法:命名空间_业务名称_widget
,这种命名方式有助于快速识别组件所属的范畴和功能,例如shop_cart_widget
代表购物车相关的小部件。
2. 函数和注释规范
2.1 函数注释标准
函数或方法注释应采用JSDoc格式,明确指出参数类型、参数作用和返回值,关键逻辑或重大变更需注明修改者和变更描述,以便于团队协作和代码维护。
2.2 示例注释
/** * 在地图上创建标志 * * @param {String} latLng 经纬度信息 * @param {Object} mapInfo 地图描点信息 * @return {Boolean} 在地图上创建点选标志的结果 * @version 20180310 modify by xxx shangsan 修改地图上描点的样式 * @version 20180314 modify by xxx wangwu 在地图上描点增加事件发送,供外部订阅 */ var placeMarkerAndPanTo=function(latLng, mapInfo) { //返回创建点选标志的结果 return true; }
3. 样式文件和响应式设计
3.1 样式文件规范
样式文件中的图片及字体文件引用需采用相对路径,支持包括PNG、JPG、GIF、BMP、WEBP和SVG格式,字体文件存放在与样式文件同级的目录中,目录必须为font
或fonts
,子层目录无具体要求但需保持清晰。
3.2 响应式设计要求
所有Widget必须支持响应式设计,通过多屏下的充分测试,以确保在不同设备上均可正确显示和使用。
4. 浏览器兼容性与数据封装
4.1 浏览器兼容处理
开发过程中需考虑到不同浏览器的兼容性问题,确保组件在各主流浏览器上均能正常运行。
4.2 数据访问封装
Widget的数据访问应该封装在Bridge中,避免直接通过ajax访问业务数据服务,从而保证数据访问的稳定性和可维护性。
5. 开放性与代码清晰度
5.1 使用开源组件
为了提高开发效率和代码质量,Widget开发可以优先使用业界优秀的开源组件,如Vue或Quasar、ElementUI等MVVM框架。
5.2 避免使用JQuery
尽管框架提供了jQuery,但应避免使用它来防止运行冲突,推荐使用原生JavaScript实现DOM操作。
6. 代码注释和FTL注释
6.1 单行和多行注释
使用单行注释//
对代码进行逐行解释,保持代码的可读性和易维护性,在关键节点,如标签结束或循环结束后,添加注释说明节点的功能和目的。
6.2 FTL注释
FTL(FreeMarker Template Language)文件中也应在关键节点后添加注释,以方便理解和维护。
7. 归纳
规范将帮助开发者确保Widget的标准化和高质量开发,同时也为团队合作提供了统一的标准和指导,遵守这些规范将大大提高产品的可维护性和用户体验。
原创文章,作者:未希,如若转载,请注明出处:https://www.kdun.com/ask/778707.html
本网站发布或转载的文章及图片均来自网络,其原创性以及文中表达的观点和判断不代表本网站。如有问题,请联系客服处理。
发表回复