于同样的项目或者是一个网页,尽管最终每个前端开发工程师都可以实现相同的效果,但是他们所写的代码一定是不同的。有的优雅,看起来清晰易懂,代码具有可拓展性,这样的代码有利于团队合作和后期的维护;而有的混乱,虽然表达出了最终的效果,然而却晦涩难懂,显然团队成员在读这样的代码时就显得无从下手,更不利于后期的维护了。那么如何写出优雅的代码呢?北京尚学堂开发部十年技术大牛总结了以下经验:
1.CSS属性应用原则。
原则1:首页DIV最小块级单位须设置高度;子页可能添加资料的DIV块不应设置高度;
原则2:css 样式继承关系必须控制在三层以内;
原则 3:所有页面文件的编码格式统一为:UTF-8;
2.CSS命名规范。
全局样式 base.css 指所有页面通用的样式,或者公共块的样式;
首页样式 index.css
频道页面样式 channel.css
详 细页面样式 detail.css
如果有特殊单独页面样式,可另取样式命。
3.页面框架结构保留字。
页面容 器:#wrap 页面头部:#header
页面中心内 容:#maincontent 页面底部:#footer
横向分段容器:section,field,column 盒子内容属性:contentbg
盒子上方属性:topbg 盒子下方属性:bottombg
盒子左边属性:leftbg 盒子右边属性:rightbg
4.导航保留字。
导航:nav 主导航:mainnav
子导 航:subnav 顶导航:topnav
边导航:sidebar 左导航:leftsidebar
右导 航:rightsidebar 菜单:menu
子菜单:submenu 下拉菜单:dropmenu
快速菜 单:quickmenu
5.功能保留字。
列表:list 标 题:title
摘要:intro 内容:text
按扭:btn 搜索:search
登 陆:login 注册:regsiter
提示信息:msg 小技巧:tips
图标: icon 滚动:scroll
6.注释。
页面和样式表里面 容易混淆,或比较重要的样式,框架样式 都应写注释
页 面内注释格式为
<!-header-> ――――――――-为开始
<!-//header-> ――――――――-为结束
样式表内注释格式为:
/*XXXX 样式开始*/
/*XXXX 样式结束*/
关于北京尚学堂开发工程师分享的网站css样式命名规范和应用原则希望对各位朋友们有所帮助,欢迎各位多多交流!有想学Java的朋友欢迎来尚学堂报名 。机不可失哦。更多技术交流者或想获取JAVA资料请加微信(858568103)
前端中的命名规范:打造整洁代码的艺术
**引言:**
在前端开发的世界中,代码质量不仅体现在功能的实现,也体现在代码的可读性与维护性上。良好的命名规范正是提升代码质量不可或缺的一部分,它如同乐谱中的音符标识,清晰有序地引导着每一位阅读者理解程序的脉络。本文将深入探讨前端开发中的命名规范,结合实例代码,带你领略命名艺术的魅力,助你编写出更易于阅读、维护和扩展的代码。
---
### **一、HTML元素命名规范**
**标题:语义化命名,让HTML结构一目了然**
```html
<!-- 不良示例 -->
<div id="d1">标题</div>
<div id="c1">内容</div>
<!-- 优秀示例 -->
<header class="site-header">标题</header>
<section class="content-section">内容</section>
```
在HTML元素命名时,应尽量使用语义化的标签,如`<header>`、`<section>`等代替无意义的`<div>`。同时,使用类名(class)描述元素的用途或样式,如`.site-header`、`.content-section`等,增强代码的可读性。
---
### **二、CSS选择器与变量命名规范**
**标题:清晰、一致、描述性**
1. **CSS选择器命名**:
```css
/* 不良示例 */
#d1 { ... }
.c1 { ... }
/* 优秀示例 */
.site-header { ... }
.content-section { ... }
```
CSS选择器应遵循一致性原则,如使用BEM(Block Element Modifier)命名法,提高代码的复用性和模块化程度。
2. **CSS变量命名**:
```css
:root {
--primary-color: #1abc9c;
--font-size-base: 16px;
}
/* 使用变量 */
body {
font-size: var(--font-size-base);
color: var(--primary-color);
}
```
CSS变量命名应具有描述性,表明其用途,如`--primary-color`和`--font-size-base`。
---
### **三、JavaScript变量、函数与类命名规范**
**标题:驼峰式命名与帕斯卡式命名的抉择**
1. **变量命名**:
```javascript
// 不良示例
let s='hello';
let counter1=0;
// 优秀示例
let greeting='hello';
let currentCount=0;
```
变量名应使用驼峰式命名法(camelCase),首字母小写,后续单词首字母大写,体现语义。
2. **函数命名**:
```javascript
// 不良示例
function c1(){...}
// 优秀示例
function calculateTotalPrice(){...}
```
函数名也应使用驼峰式命名法,并且名字应清晰反映其功能。
3. **类命名**:
```javascript
// 不良示例
class c1{...}
// 优秀示例
class ShoppingCart{...}
```
类名使用帕斯卡式命名法(PascalCase),所有单词首字母大写。
---
### **四、模块与文件命名规范**
**标题:清晰的目录结构与文件命名**
```bash
├── components/
│ ├── Button/
│ │ ├── Button.vue
│ │ └── index.js
│ ├── Header/
│ │ ├── Header.vue
│ │ └── index.js
├── utils/
│ ├── stringUtils.js
│ └── dateUtils.js
```
模块与文件命名应简洁明了,体现其内容和用途,同时保持目录结构的清晰和层级分明。
---
**结语:**
良好的命名规范就如同一把钥匙,帮助开发者快速理解代码含义,也为后期维护带来了极大的便利。在实际工作中,坚持遵循命名规范,不仅能提升团队协作效率,也有助于个人编程习惯的规范化和职业素养的养成。无论是HTML元素、CSS选择器,还是JavaScript变量与函数,乃至整个项目的架构,都应该体现出命名的艺术,共同编织出一片清爽、易读、易维护的代码森林。记住,好的代码本身就是最好的注释,而命名规范则是这幅画卷中最灵动的笔触。
SS命名规范:
喜欢的给作者点个关注哦,想要学习资料的私聊
*请认真填写需求信息,我们会在24小时内与您取得联系。