亿坊软件前端命名规范

news/2025/1/24 13:41:31/

前端开发中,文件命名的重要性不言而喻。由于历史原因和个人习惯,不同的开发者在命名DOM结构、图片和CSS文件时,可能会产生不一致的情况。这不仅会导致维护成本增加,还会降低团队协作效率。因此,制定一套统一的命名规范至关重要!
本文长期更新,请亿坊同事收藏好 - boss

需要注意的几点
1.尽量考虑为元素命名其本身的作用或”用意”,达到语义化。不要使用表面形式的命名.
如:red/left/big等。
2.组合命名规则:
[元素类型]-[元素作用/内容]
如:搜索按钮: btn-search
登录表单:form-login
新闻列表:list-news
3.涉及到交互行为的元素命名:
凡涉及交互行为的元素通常会有正常、悬停、点击和已浏览等不同样式,命名可参考以下规则:
鼠标悬停::hover 点击:click 已浏览:visited
如:搜索按钮: btn-search、btn-search-hover、btn-search-visited

目录命名
首先,目录的命名要清晰、简洁。通常,我们会按照业务模块来划分目录,例如“products”、“users”等。这样不仅方便管理,还能快速定位到相应的文件。
样式文件夹:css
脚本文件夹:js
样式类图片文件夹:img
图片命名
图片的命名同样重要。建议按照一定的顺序来命名,例如“product_1.jpg”、“product_2.jpg”,这样可以避免混乱。另外,如果图片涉及到不同的业务模块,可以在命名中加入相应的标识,例如“users_avatar.jpg”。
图片命名建议以下顺序命名
图片业务(可选)+ (mod_)图片功能类别(必选) + 图片模块名称(可选)+ 图片精度(可选)
图片功能类别:
mod_:是否公共,可选
icon:模块类固化的图标
logo:LOGO类
spr:但页面各种元素合并集合
btn:按钮
bg:可平铺或者大背景
HTML/CSS文件命名
对于HTML和CSS文件,命名要遵循一定的规则。HTML文件通常以“.html”结尾,而CSS文件则以“.css”结尾。在命名时,可以按照业务模块来划分,例如“products.html”、“users.css”。
主要的 master.css
布局,版面 layout.css
专栏 columns.css
文字 font.css
打印样式 print.css
主题 themes.css

(1)颜色:使用颜色的名称或者16进制代码,如
.red { color: red; }
.f60 { color: #f60; }
.ff8600 { color: #ff8600; }
(2)字体大小,直接使用’font+字体大小’作为名称,如
.font12px { font-size: 12px; }
.font9pt {font-size: 9pt; }
(3)对齐样式,使用对齐目标的英文名称,如
.left { float:left; }
.bottom { float:bottom; }

另外在编辑样式表时可用的注释可这样写:
<– Footer –>
内容区
<– End Footer –>

ClassName命名
最后,ClassName的命名也是关键。建议使用有意义的命名,避免使用过于简单或模糊的名称。例如,可以使用“product-name”来代替“p-name”,这样更有助于代码的可读性和维护性。

ClassName含义
关于about
页头header
登录条loginbar
标志logo
商标brand
侧栏sidebar
广告banner
导航nav
次级的,子级的sub
子导航subnav
顶部导航opnav
主导航mainnav
迷你导航mininav
导航文本textnav
子导航/二级导航subnav
图标icon
菜单menu
子菜单submenu
搜索search
滚动scroll
页面主体warpper
内容content
皮肤skin
表单from
购物区shop
标签页tab
列表/清单list
新闻列表newslist
下载列表downloadlist
图片列表piclist
下拉菜单dropmenv
圆角cor/corner
首页homepage
指南guild
提示信息msg
小技巧tips
栏目标题title
服务service
热点hot
新闻news
下载download
状态status
按钮btn
投票vote
友情链接link
页脚footer
版权copyright
网站地图sitemap
会员卡card
头像face/avatar
关闭close
登陆login
注册register
密码password
布局layout
大divbigdiv
左分栏leftdiv
右分栏rightdiv
左浮动leftfloat
右浮动rightfloat
mainbox
子页面/二级页面subpage
错误error
描述description
帮助help
分享share
提交submit
略图thumb
时间time
视频video
容器,包,一般用于最外层wrap
容器,包,一般用于最外层wrapper
成功(提示)success
模块module
更多(展开)more
作者author

以上标签同时适用亿坊CMS - https://www.yifangcms.com/docs/9/


http://www.ppmy.cn/news/1565794.html

相关文章

HTML `<head>` 元素详解

在 HTML 文档中&#xff0c;<head> 元素是一个非常重要的部分&#xff0c;它包含了文档的元数据&#xff08;metadata&#xff09;和其他与文档相关的信息。虽然 <head> 中的内容不会直接显示在网页上&#xff0c;但它对网页的行为、样式和搜索引擎优化&#xff08…

Vue 拦截监听原理

Vue 渐进式JavaScript 框架 学习笔记 - Vue 拦截监听原理 目录 拦截监听原理 如何跟踪变化 拦截监听示例 观察者 注意:vue3的变化 总结 拦截监听原理 如何跟踪变化 当你把一个普通的Javascript 对象传入 Vue 实例作为data选项&#xff0c;Vue 将遍历此对象所有的proper…

互联网产品品牌形象构建与开源AI智能名片S2B2C商城小程序的应用研究

摘要&#xff1a;随着互联网技术的飞速发展&#xff0c;互联网产品之间的竞争愈发激烈。为了在市场中占据一席之地&#xff0c;企业不仅需要提供高质量的产品和服务&#xff0c;还需要构建一个鲜明、有个性或统一的品牌形象&#xff0c;以增强用户的认知度和忠诚度。然而&#…

Grafana 统一可视化了,告警如何统一?

对于大部分公司&#xff0c;通常都不止一套监控、可观测性相关的系统&#xff0c;云上的、云下的&#xff0c;开源的、商业的&#xff0c;指标的、日志的、链路的&#xff0c;各个系统体验不同&#xff0c;权限难管&#xff0c;如何统一化并为各个团队赋能&#xff0c;是很多技…

LangGraph:基于图结构的智能系统开发与实践

一、背景知识 &#xff08;一&#xff09;人工智能发展趋势 随着人工智能技术的迅猛发展&#xff0c;我们正从简单的单一智能体模型向更加复杂的多智能体系统和知识表示结构演进。传统的人工智能系统在处理复杂任务和大规模数据时面临着诸多挑战&#xff0c;例如&#xff0c;…

算法题之栈与队列:理论基础与常用操作接口

栈与队列 &#xff08;1&#xff09;理论基础 栈&#xff1a;先进后出的数据结构 队列&#xff1a;先进先出的数据结构 栈提供push 和 pop 等等接口&#xff0c;所有元素必须符合先进后出规则&#xff0c;所以栈不提供走访功能&#xff0c;也不提供迭代器(iterator)。 不像是…

API接口技术:电商数据与反向海淘的桥梁

在数字经济蓬勃发展的今天&#xff0c;电商行业作为其中的重要一环&#xff0c;不断推动着商业模式的创新和变革。电商平台的涌现和消费者购物习惯的变化&#xff0c;使得跨平台电商数据整合成为电商企业提升竞争力、优化用户体验和实现精准营销的重要手段。在这个过程中&#…

时间类型数据处理:基于Python的datetime库和pandas库

一、datetime库常用方法 日期的数据类型主要有两种&#xff1a;一是包含时间的datetime类型&#xff0c;二是不包含时间的date类型。这里的时间指具体的时、分、秒、甚至毫秒。 1、自定义日期、时间、获取本地时间、获取本地日期、获取年份、月份、月号、小时、分钟、秒、星期…