css和js的命名规范

               笔者在撸代码是也会遇到不知道给元素或变量起什么名字的问题,中文拼音太俗气,随便敲几个字母又影响代码的查读性。于是总结这些命名规范。有些资料来源于网络

 

         一 .css命名规范

      1.命名规则说明:   

1)、所有的命名最好都小写
2)、属性的值一定要用双引号(“”)括起来,且一定要有值如class=”divcss5”,id=”divcss5”
3)、每个标签都要有开始和结束,且要有正确的层次,排版有规律工整
4)、空元素要有结束的tag或于开始的tag后加上”/”
5)、表现与结构完全分离,代码中不涉及任何的表现元素,如style、font、bgColor、border等
6)、<h1>到<h5>的定义,应遵循从大到小的原则,体现文档的结构,并有利于搜索引擎的查询。
7)、给每一个表格和表单加上一个唯一的、结构标记id
8)、给图片加上alt标签
9)、尽量使用英文命名原则
10)、尽量不缩写,除非一看就明白的单词


   2.相对网页外层重要部分CSS样式命名:

外套 wrap ——————用于最外层
头部 header —————-用于头部
主要内容 main ————用于主体内容(中部)
左侧 main-left ————-左侧布局
右侧 main-right ———–右侧布局
导航条 nav —————–网页菜单导航条
内容 content —————用于网页中部主体
底部 footer —————–用于底部

    3.DIV+CSS命名参考表:   

                  DIV CSS命名集合:

CSS样式命名 说明
网页公共命名
#wrapper 页面外围控制整体布局宽度 #container或#content 容器,用于最外层 #layout 布局 #head, #header 页头部分 #foot, #footer 页脚部分 #nav 主导航 #subnav 二级导航 #menu 菜单 #submenu 子菜单 #sideBar 侧栏 #sidebar_a, #sidebar_b 左边栏或右边栏 #main 页面主体 #tag 标签 #msg #message 提示信息 #tips 小技巧 #vote 投票 #friendlink 友情连接 #title 标题 #summary 摘要 #loginbar 登录条 #searchInput 搜索输入框 #hot 热门热点 #search 搜索 #search_output 搜索输出和搜索结果相似 #searchBar 搜索条 #search_results 搜索结果 #copyright 版权信息 #branding 商标 #logo 网站LOGO标志 #siteinfo 网站信息 #siteinfoLegal 法律声明 #siteinfoCredits 信誉 #joinus 加入我们 #partner 合作伙伴 #service 服务 #regsiter 注册 arr/arrow 箭头 #guild 指南 #sitemap 网站地图 #list 列表 #homepage 首页 #subpage 二级页面子页面 #tool, #toolbar 工具条 #drop 下拉 #dorpmenu 下拉菜单 #status 状态 #scroll 滚动 .tab 标签页 .left .right .center 居左、中、右 .news 新闻 .download 下载 .banner 广告条(顶部广告条) 电子贸易相关 .products 产品 .products_prices 产品价格 .products_description 产品描述 .products_review 产品评论 .editor_review 编辑评论 .news_release 最新产品 .publisher 生产商 .screenshot 缩略图 .faqs 常见问题 .keyword 关键词 .blog 博客 .forum 论坛

CSS文件命名 说明
master.css,style.css 主要的
module.css 模块
base.css 基本共用
layout.css 布局,版面
themes.css 主题
columns.css 专栏
font.css 文字、字体
forms.css 表单
mend.css 补丁
print.css 打印

CSS命名其它说明:

DIV+CSS命名小结:无论是使用“.”(小写句号)选择符号开头命名,还是使用“#”(井号)选择符号开头命名都无所谓,但我们最好遵循,主要的重要的特殊的最外层的盒子用“#”(井号)选择符号开头命名,其它都用“.”(小写句号)选择符号开头命名,同时考虑命名的css选择器在HTML中重复使用调用。

通常我们最常用主要命名有:wrap(外套、最外层)、header(页眉、头部)、nav(导航条)、menu(菜单)、title(栏目标题、一般配合h1\h2\h3\h4标签使用)
、content (内容区)、footer(页脚、底部)、logo(标志、可以配合h1标签使用)、banner(广告条,一般在顶部)、copyRight(版权)。其它可根据自己需要选择性使用。

DIVCSS5建议:主要的、重要的、最外层的盒子用“#”(井号)选择符号开头命名,其它都用“.”(小写句号)选择符号开头命名。

   2.css样式文件命名如下 

     主要的 master.css 
     布局,版面 layout.css 
     专栏 columns.css 
     文字 font.css 
     打印样式 print.css 
     主题 themes.css

 

     然后一些div包含的元素的命名可以以div名字为前缀再加其所在位置属性的英文名缩写


   二.js命名规范


 1.变量命名        

         1. 匈牙利命名:

           开头字母用变量类型的缩写,其余部分用变量的英文或英文的缩写,要求单词第一个字母大写。

           For example: long lsum = 0;”l”是类型的缩写;

           s:表示字符串。例如:sName,sHtml;
           n:表示数字。例如:nPage,nTotal;
           b:表示逻辑。例如:bChecked,bHasLogin;
           a:表示数组。例如:aList,aGroup;
           r:表示正则表达式。例如:rDomain,rEmail;
            f:表示函数。例如:fGetHtml,fInit;
            o:表示以上未涉及到的其他对象,例如:oButton,oDate;
           g:表示全局变量,例如:gUserName,gLoginTime;

 

        2. 驼峰式:

            第一个单词首字母小写,后面其他单词首字母大写。

            For example:  firstName 

 

  2.函数命名

    函数命名:统一使用动词或者动词+名词形式 —- fnInit()

   对象方法命名使用fn+对象类名+动词+名词形式   fnAnimateDoRun() 

   某事件响应函数命名方式为fn+触发事件对象名+事件名或者模块名  fnDivClick()

   附常用的动词列表:

get 获取/set 设置, add 增加/remove 删除
create 创建/destory 移除 start 启动/stop 停止
open 打开/close 关闭, read 读取/write 写入
load 载入/save 保存, create 创建/destroy 销毁
begin 开始/end 结束, backup 备份/restore 恢复
import 导入/export 导出, split 分割/merge 合并
inject 注入/extract 提取, attach 附着/detach 脱离
bind 绑定/separate 分离, view 查看/browse 浏览
edit 编辑/modify 修改, select 选取/mark 标记
copy 复制/paste 粘贴, undo 撤销/redo 重做
insert 插入/delete 移除, add 加入/append 添加
clean 清理/clear 清除, index 索引/sort 排序
find 查找/search 搜索, increase 增加/decrease 减少
play 播放/pause 暂停, launch 启动/run 运行
compile 编译/execute 执行, debug 调试/trace 跟踪
observe 观察/listen 监听, build 构建/publish 发布
input 输入/output 输出, encode 编码/decode 解码
encrypt 加密/decrypt 解密, compress 压缩/decompress 解压缩
pack 打包/unpack 解包, parse 解析/emit 生成
connect 连接/disconnect 断开, send 发送/receive 接收
download 下载/upload 上传, refresh 刷新/synchronize 同步
update 更新/revert 复原, lock 锁定/unlock 解锁
check out 签出/check in 签入, submit 提交/commit 交付
push 推/pull 拉, expand 展开/collapse 折叠
begin 起始/end 结束, start 开始/finish 完成
enter 进入/exit 退出, abort 放弃/quit 离开
obsolete 废弃/depreciate 废旧, collect 收集/aggregate 聚集


附上一段代码细细品味

var ClassName = function(){//类名

     var _FieldName = “Test Field”;//私有变量

     this.PropertyName = “Test Property Name”; //属性

     var functionName = function(){//私有方法

     return ”“;

}               A:加 _ 下划线前缀  


this.PublicFunctionName = function(pTestName){//公有方法 pTestName:参数

     var condition = “condition”;//局部变量

     if(condition){//判断

         return functionName();

     }else{}               B:小写开头           



     var nameCol = [“a”,”b”]; //数组

     var nameItem = nameCol[0]; //数组项

     for(var i = 0; i < nameCol.length; i++){//循环

     }                        C:大写开头     


     var selectName = “item”;

     switch(selectName){//选择

         case “item”:

         break;

     }                       D:加小写p前缀

}




  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值