常见命名规范及注释规则 — 前端篇


1、背景

目前在项目文件、样式、变量、函数等等命名没有专门特定的规范,对项目整洁性、可维护性造成一定的影响;对于多人开发多人迭代项目、命名的统一性可方便人员相互快速了解开发逻辑及业务内容。为提高团队协作效率和前端后期优化维护,下面列出前端命名的规则。

2、文件命名规范

    组件文件夹名称:字母小写,横杠连接 => header-navigation、foot-navigation
    组件页面名称:字母小写,横杠连接 => header-list.vue、table-detail.vue
    页面文件夹名称:字母小写,横杠连接 => purchase-order、delivery-notice
    页面名称:字母小写,横杠连接 => order-list.vue、order-detail.vue

3、css 命名规范

    字母小写,横杆连接 ;单词数量保持在1-4个区间,且保证语义化。
    推荐格式 : 文件名称 – 页面位置/范围 – 名称/功能

示例 :order – wrap 、order – header – title、order – middle – line 、order – footer – submit

4、js 命名规范

    变量常量命名 : 小驼峰 ;单词数量在1-3个区间,且保证语义化
    let orderParams = {} 、let orderNumber = 100 、 const orderPage = []
    函数命名 :小驼峰 ; 单词数量在1-3个区间,且保证语义化
    submitOrder(){}、deleteOrder(){} 、confirmOrder(){}
    其中形参实参也要保持小驼峰命名
    getOrderList(orderNumber){
    Return orderNumber + 100
    }
    getOrderList(orderNumber)

注释规则

    结构注释
    分级注释,分块注释
    常见命名规范及注释规则 -- 前端篇

    方法注释
    方法基本功能注释,入参注释,复杂逻辑注释
    常见命名规范及注释规则 -- 前端篇

    属性值注释
    多状态属性全部场景注释

常见命名规范及注释规则 -- 前端篇

    布尔值注释
    t/f注释
    常见命名规范及注释规则 -- 前端篇

语义命名参考 – 可补充

常见命名规范及注释规则 -- 前端篇

原创:https://www.panoramacn.com
源码网提供WordPress源码,帝国CMS源码discuz源码,微信小程序,小说源码,杰奇源码,thinkphp源码,ecshop模板源码,微擎模板源码,dede源码,织梦源码等。

专业搭建小说网站,小说程序,杰奇系列,微信小说系列,app系列小说

常见命名规范及注释规则 -- 前端篇

免责声明,若由于商用引起版权纠纷,一切责任均由使用者承担。

您必须遵守我们的协议,如果您下载了该资源行为将被视为对《免责声明》全部内容的认可-> 联系客服 投诉资源
www.panoramacn.com资源全部来自互联网收集,仅供用于学习和交流,请勿用于商业用途。如有侵权、不妥之处,请联系站长并出示版权证明以便删除。 敬请谅解! 侵权删帖/违法举报/投稿等事物联系邮箱:2640602276@qq.com
未经允许不得转载:书荒源码源码网每日更新网站源码模板! » 常见命名规范及注释规则 — 前端篇
关注我们小说电影免费看
关注我们,获取更多的全网素材资源,有趣有料!
120000+人已关注
分享到:
赞(0) 打赏

评论抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址

您的打赏就是我分享的动力!

支付宝扫一扫打赏

微信扫一扫打赏