uni-app建议风格指南

命名风格

  • uni-app的class类名使用中划线链接,命名以功能或者位置命名,举例 class=“title-left”
    参考

  • uni-app的函数命名规范,推荐使用驼峰命名法,其中首字母小写,名字要语义清晰

  • data内参数或者函数参数使用驼峰命名,关键参数或者有歧义的参数应该有参考备注

  • 页面的命名使用驼峰命名,而组件的命名则使用中划线命名,将两者能够更好的分别

函数

  1. 在页面内定义函数和参数需要有备注,定义此方法的含义及其使用, 生命周期函数推荐使用uni-app的内置自带函数,不推荐使用vue的生命函数

  2. 在页面中使用this 推荐在全局置顶设置_this 这样会保持风格统一 且节省代码

  	<script>
  	var _this
  		export default {
  		data(){
  			return{
  			}
  		},
  	onLoad() {
  		_this=this
  		// 后面可以全部使用_this替代this
  		}
  	}
  	</script>

  1. 公共方法的封装都需要有使用注释及其参数注释,单个方法保持功能单一,耦合度低 ,常用的方法写在单独的文件内 ,使用频繁的可以挂载到原型,至于使用频率低的不建议挂载至原型

  2. 对于接口的使用要独立封装,节约代码量,统一保存请求头及其token 这样可以尽量保持对接接口参数的可控性

  3. 一个方法的代码量不应该过多 ,及时解耦 ,fro循环推荐使用map forEach reduce代替 对于判断很多业务量的时候建议 switch

注释规范

  • 要求在页面头部起一行注释,表明这个页面是什么页面 例:
<!-- 订单详情页面 -->
  • 封装公共方法,需要注释含义及参数,封装的接口api列表也需要注释用途
  • 封装的公共组件需要注明props的参数含义,以及使用方法备注
  • 复杂逻辑可以写明自己的思路

发布规范 && 提交规范

  • 提交代码先拉取最先代码 在本地合并,自测无误后再提交到自己的分支,再合并到developer
  • 提交时允许保留关键调试信息,但debugger等语句必须删除

编码规范

  • tab为2个空格 代码格式保持统一
  • 编写函数时候,尽量避免回调地狱,可以使用promise作为链式调用
  • ifelse不能嵌套太深,不然难以维护
  • 单页面代码量不不超过两千行,超过则及时拆解
发布了31 篇原创文章 · 获赞 5 · 访问量 804

猜你喜欢

转载自blog.csdn.net/weixin_45899022/article/details/103391777