2025-11-15 03:28:35

前言

命名规范的重要性:命名规范的重要性不下于代码说明的重要性,很多可以通过命名的类或者函数,避免重复开发,而在日常开发中的沟通,有时候是面对面的、有的时候是通信工具,有时候是邮件、或者有时候是共同遵守的规则或者习惯。好的习惯可以使一个人成为优秀的人,也可以使一个团队成为一个高效的团队,沟通无障碍的团队,那么也需要有统一的命名规范。

开发中需要对各种域(范围或者维度的)命名要有一定的规范性,由于程序员的英文水平不同,在实际开发中也可以使用汉语拼音来作为命名的基础。把每次新增的概念或者名称录入命名库,从库中可以看到每个命名的含义。

文章目录前言一、命名的规则规范1、文件的命名规则2、文件命名规范3、名称命名规范4、代码命名规范5、函数的命名二、常见命名法1、标题驼峰命名法(CamelCase)2、蛇形命名法(snake_case)3 串式命名法(kebab-case)

一、命名的规则规范

1、文件的命名规则

网站中的所有文件命名全部用英文字母、数字、下划线、连字符的组合,其中不得包含汉字、空格和特殊字符。

尽量采用语义明确简单地英文单词命名。

常见命名常见命名静态首页文件index/default图片文件夹img/images样式表文件夹css/styles脚本文件夹js/scripts字体文件夹fonts板文件夹templets媒体文件夹medias2、文件命名规范

常见的文件命名

框架布局/布局,版面layout.css字体样式font.css链接样式link.css打印样式print.css主要的master.css专栏columns.css主题themes.css

3、名称命名规范

常见名称命名

页 眉header页 脚footer导 航menu版 权copyright主导航mainMenu / mainnav子导航subMenu / subnav顶导航topnav边导航sidebar左导航leftsidebar右导航rightsidebar边导航图标sidebarIcon面包屑breadcrumb内 容content容 器container登 录login标 志logo标 题title商 标label侧边栏sidebar外 套wrap图 标Icon标 语banner注 释note信息框manage搜 索search按 钮btn链 接link当前的current菜单内容menu content菜单容量menu container子菜单submenu标语/广告banner搜索search功能区shop4、代码命名规范

常见的属性代码目录

g_全局变量s_静态变量m_c++类成员变量c_常量a_数组p_指针fn_函数v_无效h_句柄l_长整型b_布尔f_浮点型dw_双字sz_字符串n_短整型c_计数d_双精度浮点ch_字符i_整型by_字节w_字r_实型u_无符号Init_初始化Max_最大Min_最小Dest_目的对象T_临时变量(或Temp)Src_源对象5、函数的命名

函数名使用下划线分割小写字母的方式命名:

设备名_操作名();

操作名一般采用:谓语(此时设备名作为宾语或者标明操作所属的模块)或者谓语 宾语/表语(此时设备名作为主语或者标明操作所属的

tic_init();

adc_is_busy(){};

this.uart_tx_char();

二、常见命名法

1、标题驼峰命名法(CamelCase)

骆驼式命名法(Camel-Case)

又称驼峰式命名法,是电脑程式编写时的一套命名规则(惯例)。正如它的名称CamelCase就像名称所表示的一样,指的是多种混合使用大小写字母来构成标识符的名称。使用者为了自己的代码能更容易的在同行之间交流,所以多采取统一的可读性比较好的命名方式。

小驼峰命名法(lowerCamelCase)

除第一个单词之外,其他单词首字母大写。方法名、参数名、成员变量、局部变量需要使用小驼峰命名法。

// 小驼峰命名法

humpName()

toHome()

const conflictQuantity= ref(0)

大驼峰命名法(CamelCase)

相比小驼峰法,大驼峰法把第一个单词的首字母也大写了,常用于类名,命名空间等。

// 大驼峰命名法

class GetTimeAndDate{}

class SendingTimeAndDate{}

SettingHistory

2、蛇形命名法(snake_case)

蛇形法就是全由小写字母和下划线或者大写字母和下划线组成,在两个单词之间用下滑线连接即可。测试方法名、常量、枚举名称需要使用蛇形命名法(snake_case)。

hump_name

first_name

min_height

MAX_HEIGHT

const conflict_quantity = ref('')

3 串式命名法(kebab-case)

在串式命名法中,各个单词之间通过下划线“-”连接,比如

hump-name

first-name

min_height

事实上没有哪一种命名规则可以让所有的程序员都赞同,程序设计教科书一般都不指定命名规则。

只要简单明了,能明白其意就行。

命名规则对软件产品而言并不是“成败悠关”的事,我们不要化太多精力试图发明世界上最好的命名规则,而应当制定一种令大多数项目成员满意的命名规则,并在项目中贯彻实施。