福州企业公司网站建设,济南做网站互联网公司,网站有没有做网站地图怎么看,企业网站 域名注册驼峰命名法 骆驼式命名法#xff08;Camel-Case#xff09;又称驼峰式命名法#xff0c;也称小驼峰式命名法。骆驼式命名法就是当变量名或函数名是由一个或多个单词连结在一起时#xff0c;第一个单词以小写字母开始#xff1b;从第二个单词开始以后的每个单词的首字母都采… 驼峰命名法 骆驼式命名法Camel-Case又称驼峰式命名法也称小驼峰式命名法。骆驼式命名法就是当变量名或函数名是由一个或多个单词连结在一起时第一个单词以小写字母开始从第二个单词开始以后的每个单词的首字母都采用大写字母。例如myFirstName、myLastName这样的变量名看上去就像骆驼峰一样此起彼伏故得名。匈牙利命名法 据说这种命名法是一位叫 Charles Simonyi 的匈牙利程序员发明的后来他在微软待了几年于是这种命名法就通过微软的各种产品和文档资料向世界传播开了。 匈牙利命名法的基本原则是变量名属性类型对象描述 。例子pfnEatApple pfn 是类型描述表示指向函数的指针 EatApple 是变量对象描述所以它表示指向 EatApple 函数的函数指针变量。hwnd h 是类型描述表示句柄 wnd 是变量对象描述表示窗口所以 hwnd 表示窗口句柄g_cch g_ 是属性描述表示全局变量c 和 ch 分别是计数类型和字符类型一起表示变量类型这里忽略了对象描述所以它表示一个对字符进行计数的全局变量。1属性部分g_ 全局变量
c_ 常量
m_ c类成员变量
s_ 静态变量
2类型部分数组 a
指针 p
函数 fn
无效 v
句柄 h
长整型 l
布尔 b
浮点型有时也指文件 f
双字 dw
字符串 sz
短整型 n
双精度浮点 d
计数 c通常用cnt
字符 ch通常用c
整型 i通常用n
字节 by
字 w
实型 r
无符号 u
3描述部分最大 Max
最小 Min
初始化 Init
临时变量 T或Temp
源对象 Src
目的对象 Dest
帕斯卡命名法 帕斯卡命名法指当变量名和函式名称是由二个或二个以上单词连结在一起每个单词首字母大写。单字之间不以空格断开或连接号-、底线_连结第一个单词首字母采用大写字母后续单词的首字母亦用大写字母例如FirstName、LastName。 也有人称之为大驼峰式命名法Upper Camel Case 。下划线命名法 下划线命名法变量名和函式名称是由二个或二个以上单词连结在一起每个单词用下划线隔开并且单词都是小写。例如print_employee。下划线命名法是随着C语言的出现流行起来的在UNIX/LIUNX这样的环境以及GNU代码中使用非常普遍。一些代码规范 以下来源《安富莱教程文档》1、文件与目录1文件的命名文件的命名要准确清晰地表达其内容同时文件名应该精练防止文件名过长而造成使用不便。在文件名中可以适当地使用缩写。以下提供两种命名方式以供参考各程序模块的文件命名开头 2 个消协字母代表本模块的功能如主控程序为 mpMain.cmpDisp.c 等。不写模块功能标识如主控程序为 Main.cDisp.c 等。2头文件中段落安排顺序// 1、文件头注释
// 2、防止重复引用头文件的设置
// 3、#include 部分
// 4、enum 常量声明
// 5、类型声明和定义包括 struct、union、typedef 等
// 6、全局变量声明
// 7、文件级变量声明
// 8、全局或文件级函数声明
// 9、函数实现。按函数声明的顺序排列
// 10、文件尾注释
3在引用头文件时不要使用绝对路径如果使用绝对路径当需要移动目录时必须修改所有相关代码繁琐且不安全使用相对路径当需要移动目录时只需修改编译器的某个选项即可。例如#include “/project/inc/hello.h” /* 不应使用绝对路径 */
#include “../inc/hello.h” /* 可以使用相对路径 */
4在引用头文件时 使用还是 #include stdio.h /* 标准头文件 */
#include projdefs.h /* 工程制定目录头文件 */
#include “global.h” /* 当前目录头文件 */
#include “inc/config.h” /* 路径相对于当前目录的头文件 */
5防止头文件被重复引用#ifndef __DISP_H /* 文件名前名加两个下划线“__”后面加 “_H”
#define __DISP_H
...
...
#endif
6头文件中只存放“声明”而不存放“定义”7文件的长度文件的长度没有非常严格的要求但应尽量避免文件过长。一般来说文件长度应尽量保持在 1000 行之内 。2、排版1程序块要采用缩进风格编写缩进的空格数为 4 个。2相对独立的程序块之间、变量说明之后必须加空行 。3 较长的语句或函数过程参数80 字符要分成多行书写长表达式要在低优先级操作符处划分新行操作符放在新行之首划分出的新行要进行适当的缩进使排版整齐语句可读。4 不允许把多个短语句写在一行中即一行只写一条语句5程序块的分界符如大括号‘{’和‘}’ 应各独占一行并且位于同一列6 在两个以上的关键字、变量、常量进行对等操作时它们之间的操作符之前、之后或者前后要加空格进行非对等操作时如果是关系密切的立即操作符如后不应加空格。示例逗号、分号只在后面加空格。比较操作符赋值操作符、 算术操作符、%逻辑操作符、位域操作符、^等双目操作符的前后加空格。!、~、、--、地址运算符等单目操作符前后不加空格。-、.前后不加空格。if、for、while、switch 等与后面的括号间应加空格使 if 等关键字更为突出、明显函数名与其后的括号之间不加空格以与保留字区别开。3、注释1 一般的源程序有效注释量必须在 20以上。说明注释的原则是有助于对程序的阅读理解在该加的地方都加注释不宜太多也不能太少注释语言必须准确、易懂、简洁 。2 在文件的开始部分应该给出关于文件版权、内容简介、修改历史等项目的说明。在创建代码和每次更新代码时都必须在文件的历史记录中标注版本号、日期、作者、更改说明等项目。下面是一个范例当然并不局限于此格式但上述信息建议要包含在内。3对于函数在函数实现之前应该给出和函数的实现相关的足够而精练的注释信息。示例下面这段函数的注释比较标准当然并不局限于此格式但上述信息建议要包含在内。4 边写代码边注释修改代码同时修改相应的注释以保证注释与代码的一致性。不再有用的注释要删除。5 注释的内容要清楚、明了含义准确防止注释二义性。说明错误的注释不但无益反而有害。注释主要阐述代码做了什么What或者如果有必要的话阐述为什么要这么做Why注释并不是用来阐述它究竟是如何实现算法How的。6 避免在注释中使用缩写特别是非常用缩写。说明在使用缩写时或之前应对缩写进行必要的说明。7 注释应与其描述的代码靠近对代码的注释应放在其上方或右方对单条语句的注释相邻位置 不可放在下面如放于上方则需与其上面的代码用空行隔开。示例如下例子不符合规范。例 1不规范的写法例 2不规范的写法例 3规范的写法例 4不规范的写法显得代码过于紧凑例 5规范的写法8 注释与所描述内容进行同样的缩排。说明可使程序排版整齐并方便注释的阅读与理解。例 1如下例子排版不整齐阅读稍感不方便。例 2正确的布局。9 对变量的定义和分支语句条件分支、循环语句等必须编写注释。说明这些语句往往是程序实现某一特定功能的关键对于维护人员来说良好的注释帮助更好的理解程序有时甚至优于看设计文档。10 对于 switch 语句下的 case 语句如果因为特殊情况需要处理完一个 case 后进入下一个 case 处理必须在该 case 语句处理完、下一个 case 语句前加上明确的注释。说明这样比较清楚程序编写者的意图有效防止无故遗漏 break 语句。示例注意斜体加粗部分11 注释格式尽量统一建议使用“/* …… */”因为 C注释“//”并不被所有 C 编译器支持。12 注释应考虑程序易读及外观排版的因素使用的语言若是中、英兼有的建议多使用中文除非能非常流利准确的用英文表达。说明注释语言不统一影响程序易读性和外观排版出于对维护人员的考虑建议使用中文。13 标识符的命名要清晰、明了有明确含义同时使用完整的单词或大家基本可以理解的缩写避 免使人产生误解。说明较短的单词可通过去掉“元音”形成缩写较长的单词可取单词的头几个字母形成缩写一些单词有大家公认的缩写。示例如下单词的缩写能够被大家基本认可。temp 可缩写为 tmp;
flag 可缩写为 flg;
statistic 可缩写为 stat;
increment 可缩写为 inc;
message 可缩写为 msg;14 命名中若使用特殊约定或缩写则要有注释说明。说明应该在源文件的开始之处对文件中所使用的缩写或约定特别是特殊的缩写进行必要的注释说明。15 自己特有的命名风格要自始至终保持一致不可来回变化。说明个人的命名风格在符合所在项目组或产品组的命名规则的前提下才可使用。即命名规则中没有规定到的地方才可有个人命名风格16 对于变量命名禁止取单个字符如 i、j、k…建议除了要有具体含义外还能表明其变量类型、数据类型等但 i、j、k 作局部循环变量是允许的。变量尤其是局部变量如果用单个字符表示很容易敲错如i写成j而编译时又检查不出来有可能为了这个小小的错误而花费大量的查错时间 。17 命名规范必须与所使用的系统风格保持一致并在同一项目中统一比如采用 UNIX 的全小写加下划线的风格或大小写混排的方式不要使用大小写与下划线混排的方式用作特殊标识如标识成员变量或全局变量的 m_和 g_其后加上大小写混排的方式是允许的。示例Add_User不允许add_user、AddUser、m_AddUser允许。18 除非必要不要用数字或较奇怪的字符来定义标识符。示例如下命名使人产生疑惑。应改为有意义的单词命名4、可读性1 注意运算符的优先级并用括号明确表达式的操作顺序避免使用默认优先级。2 避免使用不易理解的数字用有意义的标识来替代。示例如下的程序可读性差应改为如下形式 3 不要使用难懂的技巧性很高的语句除非很有必要时。说明高技巧语句不等于高效率的程序实际上程序的效率关键在于算法。示例如下表达式考虑不周就可能出问题也较难理解。应分别改为如下5、变量、 结构、 常量、 宏1 为了方便书写及记忆变量类型采用如下重定义2 常见类型的前缀对于一些常见类型的变量应在其名字前标注表示其类型的前缀。前缀用小写字母表示。前缀的使用请参照下列表格中说明。3 变量作用域的前缀为了清晰的标识变量的作用域减少发生命名冲突应该在变量类型前缀之前再加上表示变量作用域的前缀并在变量类型前缀和变量作用域前缀之间用下划线 - 隔开。具体的规则如下对于全局变量global variable在其名称前加g和变量类型符号前缀。 uint32_t g_ulParaWord;uint8_t g_ucByte;
对于静态变量static variable在其名称前加s和变量类型符号前缀。 static uint32_t s_ulParaWord;static uint8_t s_ucByte;
函数内部等局部变量前不加作用域前缀。对于常量当可能发生作用域和名字冲突问题时以上几条规则对于常量同样适用。注意虽然常量名的核心部分全部大写但此时常量的前缀仍然用小写字母以保持前缀的一致性。4 结构体命名规则表示类型的名字所有名字以小写字母tag开头之后每个英文单词的第一个字母大写包括第一个单词的第一个字母其他字母小写结尾_T 标识。单词之间不使用下划线分隔,结构体变量以 t 开头。如/* 结构体命名类型名 */
typedef struct tagBillQuery_T
{
...
}BillQuery_T;
/* 结构体变量定义 */
BillQuery_T tBillQuery;
5对于枚举定义全部采用大写结尾_E 标识。6常量、宏、模版的名字应该全部大写。如果这些名字由多个单词组成则单词之间用下划线分隔。#define LOG_BUF_SIZE 8000
6、函数1 函数的命名规则。每一个函数名前缀需包含模块名模块名为小写与函数名区别开。如uartReceive(串口接收)备注对于非常简单的程序可以不加模块名。2函数的形参。函数的的形参都以下划线_开头已示与普通变量进行区分对于没有形参为空的函数(void)括号紧跟函数后面。uint32_t uartConvUartBaud(uint32_t _ulBaud){}
3 一个函数仅完成一件功能。4 函数名应准确描述函数的功能使用动宾词组为执行某操作的函数命名。说明避免用含义不清的动词如process、handle等为函数命名因为这些动词并没有说明要具体做什么。示例参照如下方式命名函数。5避免设计五个以上参数函数不使用的参数从接口中去掉。说明目的减少函数间接口的复杂度复杂的参数可以使用结构传递。6在调用函数填写参数时应尽量减少没有必要的默认数据类型转换或强制数据类型转换。说明因为数据类型转换或多或少存在危险。7 防止把没有关联的语句放到一个函数中。示例如下函数就是一种随机内聚。矩形的长、宽与点的坐标基本没有任何关系故以上函数是随机内聚。应如下分为两个函数扫码或长按关注回复「 篮球的大肚子」进入技术群聊
