前端-命名规范

=============================================JS部分
0.包
全部小写,多级包用 "." 隔开
1.变量
前缀为形容词,小驼峰式命名法。如:maxCount = 10;
2.常量
使用大写字母和下划线来组合命名,下划线用来分割单词。如:MAX_COUNT = 10;
3.函数 & 方法
前缀应该为动词,小驼峰式命名法。如:getName() {}
附动词表:
can 判断是否可执行某个动作
has 判断是否含义某个值
is 判断是否为某个值
get 获取某个值
set 设置某个值
load 加载某些数据
4.类 & 构造函数
大写驼峰式命名法,如:class Persion{constructor(name) {}};new Person('啦啦啦');
5.私有属性和方法
前缀为下划线。如:class Person {_name: string;}
6.注释
@param {参数类型} 描述信息-------------@param {String} name 传入名称
@return {参数类型} 描述信息------------@retun {Boolean} true: 可执行; false: 不可执行
@author 描述信息-----------------------@author 某某某 2018/04/24
@example 示例代码----------------------@example setTitle('啦啦啦');

=============================================CSS中命名
1.中划线表示层级关系 如:.box-list-item
2.下划线表示不同的状态 如:.box-btn_default
3.m-前缀表示这是组件 如:.m-btn
=============================================功能部分
头:header  
内容:content/container  
尾:footer  
导航:nav  
侧栏:sidebar
栏目:column  


页面外围控制整体布局宽度:wrapper  
左右中:left right center  
登录条:loginbar  
标志:logo  
广告:banner  
页面主体:main  
热点:hot  
新闻:news
下载:download  
子导航:subnav  
菜单:menu  
子菜单:submenu  
搜索:search  
友情链接:friendlink  
页脚:footer  
版权:copyright  
滚动:scroll  
内容:content
标签页:tab
文章列表:list
提示信息:msg
小技巧:tips
栏目标题:title
加入:joinus
指南:guild
服务:service
注册:regsiter
状态态:status
投票:vote
合作伙伴:partner

注释的写法

/* Footer */
内容区
/* End Footer */

id的命名
容器: container
页头:header
内容:content/container
页面主体:main
页尾:footer
导航:nav
侧栏:sidebar
栏目:column
页面外围控制整体布局宽度:wrapper
左右中:left right center

 

页面结构

容器: container
页头:header
内容:content/container
页面主体:main
页尾:footer
导航:nav
侧栏:sidebar
栏目:column
页面外围控制整体布局宽度:wrapper
左右中:left right center

导航

导航:nav
主导航:mainbav
子导航:subnav
顶导航:topnav
边导航:sidebar
左导航:leftsidebar
右导航:rightsidebar
菜单:menu
子菜单:submenu
标题: title
摘要: summary

功能
标志:logo
广告:banner
登陆:login
登录条:loginbar
注册:regsiter
搜索:search
功能区:shop
标题:title
加入:joinus
状态:status
按钮:btn
滚动:scroll
标签页:tab
文章列表:list
提示信息:msg
当前的: current
小技巧:tips
图标: icon
注释:note
指南:guild
服务:service
热点:hot
新闻:news
下载:download
投票:vote
合作伙伴:partner
友情链接:link
版权:copyright

posted on 2020-07-06 09:35  xcc_20190625  阅读(148)  评论(0)    收藏  举报

导航