C语言格式书写规范

合集下载

C语言格式书写指导规范

C语言格式书写指导规范

C语言书写规范指南第1章文件结构每个C程序通常分为两个文件。

一个文件用于保存程序的声明(declaration),称为头文件。

另一个文件用于保存程序的实现(implementation),称为定义(definition)文件。

C程序的头文件以“.h”为后缀,C程序的定义文件以“.c”为后缀。

1.1版权和版本的声明版权和版本的声明位于头文件和定义文件的开头(参见示例1-1),主要内容有:(1)版权信息。

(2)文件名称,标识符,摘要。

(3)当前版本号,作者/修改者,完成日期。

(4)版本历史信息。

/**Copyright(c)2001,吉林大学物理学院无线电*Allrightsreserved.**文件名称:filename.h*文件标识:*摘要:简要描述本文件的内容**当前版本:1.1*作者:输入作者(或修改者)名字*完成日期:2007年7月20日**取代版本:1.0*原作者:输入原作者(或修改者)名字*完成日期:2007年5月10日*/示例1-1版权和版本的声明1.2头文件的结构头文件由三部分内容组成:(1)头文件开头处的版权和版本声明(参见示例1-1)。

(2)预处理块。

(3)函数和类结构声明等。

假设头文件名称为SCL_SPI.h,头文件的结构参见示例1-2。

【规则1-2-1】为了防止头文件被重复引用,应当用#ifndef/#define/#endif结构产生预处理块。

【规则1-2-2】用#include <filename.h>格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。

【规则1-2-3】用#include “filename.h”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。

【规则1-2-4】#include 后面使用TAB键控制排版。

【规则1-2-5】头文件中只存放“声明”而不存放“定义”【规则1-2-6】全局变量在头文件中声明,在.c文件中定义.h extern in tvalue; 声明。

c语言注释格式

c语言注释格式

c语言注释格式
在C语言中,注释可以分为单行注释和多行注释两种格式。

其中单行注释是以“//”符号开始,直到该行末尾为止,如下所示:```c
//这是一段单行注释,用于解释代码的作用及用途
```
多行注释则是以“/*”开始,以“*/”结束,可以跨越多行,如下所示:
```c
/*
这是一段多行注释,
主要用于详细说明代码的实现方法和原理
*/
```
注释应该遵循以下规范:
1. 尽量在代码段上方或对应代码行的右边添加注释,避免注释太过密集,影响代码的可读性。

2. 注释应该简洁明了,不得包含任何与代码无关的内容。

3. 注释内容应该用中文书写,确保易于理解。

4. 不得在注释中出现任何网址、超链接和电话等信息,以避免信息泄露。

通过遵循以上规范,注释可以提高代码的可读性和易维护性,为代码的编写和维护提供便利。

C语言格式书写规范

C语言格式书写规范

C语言书写规范指南第1章文件结构每个C程序通常分为两个文件。

一个文件用于保存程序的声明(declaration),称为头文件。

另一个文件用于保存程序的实现(implementation),称为定义(definition)文件。

C程序的头文件以“.h”为后缀,C程序的定义文件以“.c”为后缀。

1.1版权和版本的声明版权和版本的声明位于头文件和定义文件的开头(参见示例1-1),主要内容有:(1)版权信息。

(2)文件名称,标识符,摘要。

(3)当前版本号,作者/修改者,完成日期。

(4)版本历史信息。

/**Copyright(c)2001,吉林大学物理学院无线电*Allrightsreserved.**文件名称:filename.h*文件标识:*摘要:简要描述本文件的内容**当前版本:1.1*作者:输入作者(或修改者)名字*完成日期:2007年7月20日**取代版本:1.0*原作者:输入原作者(或修改者)名字*完成日期:2007年5月10日*/示例1-1版权和版本的声明1.2头文件的结构头文件由三部分内容组成:(1)头文件开头处的版权和版本声明(参见示例1-1)。

(2)预处理块。

(3)函数和类结构声明等。

假设头文件名称为SCL_SPI.h,头文件的结构参见示例1-2。

【规则1-2-1】为了防止头文件被重复引用,应当用#ifndef/#define/#endif结构产生预处理块。

【规则1-2-2】用#include <filename.h>格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。

【规则1-2-3】用#include “filename.h”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。

【规则1-2-4】#include 后面使用TAB键控制排版。

【规则1-2-5】头文件中只存放“声明”而不存放“定义”【规则1-2-6】全局变量在头文件中声明,在.c文件中定义.h extern in tvalue; 声明。

c语言编程的书写规则

c语言编程的书写规则

c语言编程的书写规则C语言编程的书写规则主要遵循以下规范:1. 缩进和空格:缩进和空格的使用可以使代码更易读。

通常,运算符两侧、逗号之后、控制语句(如if、for、while等)前后应添加空格。

在函数和括号的开头和结尾,通常应有空行。

2. 命名规则:变量和函数名应简洁且有意义。

通常,变量名和函数名以小写字母开头,后续单词的首字母大写,如 `myVariable`。

3. 注释:注释应简洁明了,解释代码的作用或目的,而不是解释代码是如何工作的。

注释应放在代码的上方或旁边,与代码保持一定距离。

4. 函数:函数应该尽可能短小,只做一件事情。

函数应具有描述性的名称,参数列表应清晰,并应包含返回类型。

5. 大括号:在C语言中,大括号 `{}` 用于定义代码块。

每一个独立的语句块都应该使用大括号。

6. 控制结构:控制结构(如if-else、for、while等)应该清晰明了,控制语句应只包含必要的逻辑。

7. 类型定义:类型定义应清晰明了,如果有必要,可以使用typedef来定义新的类型名称。

8. 预处理器指令:预处理器指令(如include、define等)应放在源文件的顶部。

9. 避免魔法数字和字符串:魔法数字和字符串(硬编码的值)会使代码难以理解和维护。

如果需要在代码中使用特定的值,应将其定义为常量或宏。

10. 避免全局变量:全局变量会使代码难以理解和维护,并可能导致意外的副作用。

尽可能使用局部变量。

11. 错误处理:在可能失败的操作后,应检查错误并相应地处理它们。

以上只是一些基本的C语言编程规则,实际编写代码时可能还需要考虑更多因素,如代码的可读性、可维护性、性能等。

C语言格式规范

C语言格式规范

#include <stdio.h> int main(void)
if (…) {
while (…) } return 0; } 写完 while 那一行后,按回车,此时光标不是停在与 while 左对齐的正下方,同样,我 们不需要按 Backspace,直接输入大括号即可,系统会自动对齐到与 while 左对齐的正下 方的。
C语言代码规范
什么叫规范?在C语言中不遵守编译器的规定,编译器在编译时就会报错,这个规定叫 作规则。但是有一种规定,它是一种人为的、约定成俗的,即使不按照那种规定也不会出 错,这种规定就叫作规范。
虽然我们不按照规范也不会出错,但是那样代码写得就会很乱。大家刚开始学习C语言的 时候,第一步不是说要把程序写正确,而是要写规范。因为如果你养成一种非常不好的写 代码的习惯,代码就会写得乱七八糟,等到将来工作面试的时候,这样的习惯可能会让你 失去机会。
代码如何写才能规范
那么代码如何写才能写得很规范呢?代码的规范化不是说看完本节内容后就能实现 的。它里面细节很多,而且需要不停地写代码练习,不停地领悟,慢慢地才能掌握的一种 编程习惯。所以大家不要想着一下子就能把代码规范化的所有知识全部掌握,也不要想着 一下子就能把代码写规范,这是不太可能的。
有很多知识,比如为什么代码要这样写,为什么不能那样写,作为一个初学者你是很 难弄明白的。有很多规范是为了在程序代码量根据软件工程的思想,我们的注释要占整个文档的20%以上。所以注释 要写得很详细,而且格式要写得很规范。
第二个好处是,把代码写规范则程序不容易出错。如果按照不规范的格式输入代码的 话,很容易出错。而代码写规范的话即使出错了查错也会很方便。格式虽然不会影响程序 的功能,但会影响可读性。程序的格式追求清晰、美观,是程序风格的重要构成元素。

标准C语言规范

标准C语言规范
* 编程人员 : 宋毅红
* 编程时间 : 94.9.29
* 修改时间 :
*/
#include <curses.h>
#include <signal.h>
#include <fcntl.h>
#include "Tr_mac.h"
#include "Tr_str.h"
return(Err);
}
}
/******* added by yang yijun 95.7.25 *****/
else
{
_disp_nm(bgdc.cur); /* yyj 94.11.17.*/
return(Err);
}
}
return(Ok);
}
void_disp_nm( _sName)
char *_sName;
p------pointer
字符串数组也使用p标志
静态变量名前用s标志
数组变量名前用stru标志
全局变量使用前缀g_标志
如:dBalance,fInterest,pName,sCustomer,struPersonWang,g_iOperNo
3.书写规范
⑴对齐原则
同一层次的语句必须左对齐。“{”和“}”必须独占一行。
⑵缩进原则
不同层次的语句必须遵从缩进原则,一般缩进四个字符为宜,TAB值设为4。
Case后的语句(简短注释语句除外)应另起一行,且须与“:”相接。
⑶分行书写原则
当行超过屏幕上的行时,应分行书写。
⑷注释符要求
单行注释符使用“//”,多行注释符使用“/*……*/”,注释符必须遵从前面3条原则,

c语言 函数注释

c语言 函数注释

c语言函数注释函数注释是编程中非常重要的一部分,它能够帮助其他开发者理解函数的作用、参数要求以及返回值等信息。

在C语言中,函数注释通常使用特定的格式进行书写,以确保注释的清晰易读。

本文将介绍C语言函数注释的格式要求以及如何编写规范的函数注释。

一、函数注释的格式要求在C语言中,函数注释通常位于函数声明之前,使用特定的注释格式进行书写。

以下是常用的函数注释格式要求:1. 函数注释以"/**"开始,以"*/"结束,中间的内容为注释的具体描述。

2. 注释的第一行为函数的摘要描述,简明扼要地说明函数的功能。

3. 注释的后续行为详细描述,可以包括函数的参数说明、返回值说明、异常情况说明等。

4. 参数说明应包括参数的名称、类型、作用、是否可以为空等信息。

5. 返回值说明应说明函数的返回值类型、返回值的作用、取值范围等信息。

6. 异常情况说明应说明函数可能出现的异常情况以及如何处理。

7. 注释中可以使用合适的标点符号、缩进、换行等方式使注释更易读。

二、编写规范的函数注释1. 函数摘要描述:函数的摘要描述应简明扼要地说明函数的功能。

例如,对于一个计算两个数之和的函数,可以使用以下方式进行摘要描述:/*** 计算两个数的和*/2. 参数说明:参数说明应包括参数的名称、类型、作用、是否可以为空等信息。

例如,对于一个计算两个数之和的函数,可以使用以下方式进行参数说明:/*** 计算两个数的和** @param num1 第一个操作数* @param num2 第二个操作数** @return 两个数的和*/3. 返回值说明:返回值说明应说明函数的返回值类型、返回值的作用、取值范围等信息。

例如,对于一个计算两个数之和的函数,可以使用以下方式进行返回值说明:/*** 计算两个数的和** @param num1 第一个操作数* @param num2 第二个操作数** @return 两个数的和* 如果计算结果超出了整型的表示范围,则返回0*/4. 异常情况说明:异常情况说明应说明函数可能出现的异常情况以及如何处理。

c语言书写规则

c语言书写规则

c语言书写规则C语言是一门广泛应用于计算机编程领域的高级程序设计语言。

为了提高代码的可读性和可维护性,遵守规范的书写方式和规则是非常重要的。

本文将介绍C语言书写规则,以便程序员能够编写高质量的C代码。

一、命名规范在C语言中,命名是非常重要的。

良好的命名规范可以让代码更具可读性,并且遵循统一的命名约定可以减少混乱和错误。

以下是一些常见的命名规范:1.标识符应使用有意义的名称,能够清晰地表达其功能或作用。

2.变量名、函数名和常量名应使用小写字母,单词之间使用下划线分隔。

例如:count,print_value。

3.宏定义应全大写,并使用下划线分隔单词。

例如:MAX_VALUE。

4.结构体和枚举类型应使用首字母大写的驼峰命名法。

例如:StudentInfo,ColorType。

二、缩进和空格在C语言中,正确的缩进和空格使用可以使代码更易读和排版整洁。

1.使用一个制表符或者四个空格进行缩进,每一级缩进对应一个制表符或四个空格。

2.在运算符两侧和逗号后添加一个空格,以增加可读性。

例如:a =b + c。

3.在if、for、while等关键字后面和括号前后添加空格,以增强代码可读性。

例如:if (condition)。

三、注释规范注释是代码中重要的组成部分,它可以向其他开发者解释代码的功能和用途。

良好的注释规范可以提高代码的可维护性和可读性。

1.使用注释解释函数的作用、参数的含义、返回值等信息。

2.对于复杂的代码逻辑,使用注释进行说明和解释。

3.注释应与代码保持一致,不要出现拼写错误和过时的信息。

4.注释应该清楚简洁,不使用口头禅、行话或过度的翻译。

四、函数和变量函数和变量是C程序中最常用的元素,为了保持代码的一致性和可维护性,有一些规范需要遵守。

1.函数名应具有描述性,能够明确表达函数的功能和目的。

2.函数应尽量保持短小且功能单一,便于调试和维护。

3.变量应在使用前进行声明,并尽量在定义处进行初始化。

4.避免使用全局变量,因为它们会增加代码的复杂性和不可预测性。

华为CC语言编程规范

华为CC语言编程规范

百度文库- 让每个人平等地提升自我目录1 排版 (2)4 可读性 (11)6 函数、过程 (13)7 可测性 (14)1 排版¹1-1:程序块要采用缩进风格编写,缩进的空格数为4个。

说明:对于由开发工具自动生成的代码可以有不一致。

¹1-2:相对独立的程序块之间、变量说明之后必须加空行。

示例:如下例子不符合规范。

if (!valid_ni(ni)){... epssn_index;repssn_ni = ssn_data[index].ni;应如下书写if (!valid_ni(ni)){... epssn_index;repssn_ni = ssn_data[index].ni;¹1-3:较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。

示例:= NO7_TO_STAT_PERM_COUNT_LEN+ STAT_SIZE_PER_FRAM * sizeof( _UL );act_task_table[frame_id * STAT_TASK_CHECK_NUMBER +index].occupied= stat_poi[index].occupied;act_task_table[taskno].duration_true_or_false= SYS_get_sccp_statistic_state( stat_item );report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER)&& (n7stat_stat_item_valid (stat_item)) &&(act_task_table[taskno].result_data != 0));¹1-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。

c语言编程规范

c语言编程规范

C语言编程规范一、排版1.采用阶梯层次组织代码函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。

各层次缩紧的风格采用TAB缩进。

注意:右括号所在的行不应当有其它东西,除非跟随着一个条件判断。

也就是do-while语句中的“while”。

2.及时折行较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进(至少1个TAB位置),使排版整齐,语句可读。

循环、判断等语句中若有较长的表达式或语句,则要进行适当的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。

3.语句的书写格式1.一行只写一条语句2.switch、if、while、do、for规则如下:(1)switch语句的书写格式switch(ch){case 1://注释statements;break;case 2://注释statements;break;default://注释statements;break;}(2)if语句的书写格式If(条件){//注释statements;}else if(条件){//注释statements;}else{//注释statements;}(3)while语句的书写格式while(条件){statements;}(4)do语句的书写格式do{statements;}while(条件);//注释(5)for语句的书写格式for(...;...;...){//注释statements;}4.空行(1)变量说明之后必须加空行。

(2)相对独立的程序块之间应加空行。

5.空格(1)逗号、分号只在后面加空格。

int a,b,c;(2)比较操作符,赋值操作符“=”、“+=”,算术操作符“+”、“%”,逻辑操作符“&&”、“&”,位域操作符“<<”等双目操作符的前后加空格。

C语言的语法风格与代码书写规范指南

C语言的语法风格与代码书写规范指南

C语⾔的语法风格与代码书写规范指南C代码:#include <stdio.h>int main(void){printf("That is Right Style\n");return 0;}在⼀个标准的C语⾔程序中,最特殊的莫过于main函数了,⽽说到底它就是⼀个函数⽽已,仅仅因为它地位特殊拥有第⼀执⾏权⼒,换句话说,难道因为⼀个⼈是省长它就不是⼈类了?所以函数该有的它都应该有,那么函数还有什么呢?函数⼤体上分为内联函数(C99)(内联函数并⾮C++专属,C语⾔亦有,具体见前⽅链接)和⾮内联的普通函数,它们之间有⼀个很明显的特点(⼀般情况下),那就是不写原型直接在main函数上⽅定义,即使不加'inline'关键字,也能被编译器默认为内联函数,但之后带来的某些并发问题就不是编译器考虑的了。

普通函数正确的形式应该为声明与定义分离,声明就是⼀个函数原型,函数原型应该有⼀个函数名字,⼀个参数列表,⼀个返回值类型和⼀个分号。

定义就是函数的内在,花括号内的就是函数的定义://...int function(int arg_1, float arg_2);//...int main(int argc, char* argv[]){int output = function(11, 22.0);printf("%d\n",output);return 0;}int function(int arg_1, float arg_2){int return_value = arg_1;float temp_float = arg_2;return return_value;}依上所述,当⾮必要时,在⾃⼰编写函数的时候请注意在开头(main函数之前)写上你的函数的原型,并且在末尾(main函数之后)写上你的函数定义,这是⼀个很好的习惯以及规范。

所谓代码整洁之道,就是如此。

c语言书写格式规则

c语言书写格式规则

在C语言中,书写格式规则主要包括以下几点:
符号命名规则:符号名包括模块名、常量名、标号名、子程序名等。

命名应采用匈牙利命名法,具体规则如下:
所有宏定义、枚举常数和const变量,用大写字母命名,在复合词里用下划线隔开每个词。

复合词中每个单词的第一个字母大写,除了规则5.1.1.1以外,避免使用下划线。

类、类型定义和枚举型名的第一个字母大写。

函数名是复合词的,第一个词采用全部小写,随后每个单词采用第一个字母大写,其它字母小写方式;如果是单个词的,采用全部小写方式。

循环变量可采用i,j,k等。

类的成员变量应采用m_开头。

全局变量词头为g_。

临时变量词头为tmp_。

对结构体内的变量命名,遵循变量的具体含义命名原则。

用小写字母的前缀表示变量的类型,前缀的下一个字母用大写。

代码层次结构:使用{}来标明代码的层次结构,{}一般与该结构语句的第一个字母对齐,并单独占一行。

低一层次的语句或说明可比高一层次的语句或说明缩进若干格后书写。

注释规范:注释应与代码完全一致,每个源程序文件,都有文件头说明,每个函数,都有函数头说明。

主要变量(结构、联合、类或对象)定义或引用时,注释能反映其含义。

循环、分支层次不要超过五层。

注释可以与语句在同一行,也可以在上行。

空行和空白字符也是一种特殊注释。

一目了然的语句不加注释。

注释行数(不包括程序头和函数头说明部份)应占总行数的1/5到1/3 。

这些只是一些基础的格式规范,具体格式可能因实际项目和开发环境而有所不同。

c语言的书写格式

c语言的书写格式

C语言书写格式概述C语言是一种广泛使用的编程语言,它具有简洁、易读、灵活和高效等优点,被广泛应用于系统编程、嵌入式系统开发、数据结构和算法实现等领域。

在书写C语言代码时,需要注意一些基本的格式规范,以确保代码的可读性和可维护性。

下面将对C语言的书写格式进行简要的介绍。

代码缩进和空格C语言是一种依赖于空格和缩进来组织代码结构的编程语言,因此,正确地使用缩进和空格是非常重要的。

一般来说,每个缩进级别应该使用4个空格,这样可以清晰地分隔出代码的不同部分,方便阅读和理解。

同时,在编写代码时,应该使用空格来分隔变量、运算符和函数调用等元素,以提高代码的可读性。

注释和文档字符串注释是代码的重要组成部分,可以帮助程序员理解代码的功能和实现方式。

在C语言中,可以使用单行注释和多行注释来对代码进行解释和说明。

一般来说,应该为重要的函数和复杂的代码段添加注释,以便其他开发人员能够理解代码的功能和工作原理。

此外,还应该使用文档字符串(docstring)来描述函数的用途和参数说明,以提高代码的可维护性。

变量命名规范变量命名是编程中非常重要的一个方面,它应该具有描述性并且易于阅读。

在C语言中,变量名应该遵循一定的命名规范,如使用小写字母和下划线,避免使用单个字符作为变量名等。

同时,变量名应该具有描述性,能够清晰地表达变量的含义和用途。

函数定义格式函数是C语言中的基本构造之一,它可以将相关的代码组织在一起,提高代码的可读性和可维护性。

在定义函数时,应该遵循一定的格式规范,如使用正确的函数声明格式、参数列表和返回值类型等。

此外,还应该为函数添加注释,说明函数的用途、输入参数和返回值等信息。

控制结构书写规范在C语言中,控制结构是用来组织和控制代码的关键部分。

常见的控制结构包括if语句、switch语句、循环结构和函数调用等。

在书写这些控制结构时,应该遵循一定的规范,如使用括号来包裹表达式和分支语句、正确使用break和continue语句等。

初识C语言编码规范

初识C语言编码规范

C语言编码规范1-排版规则程序应采用缩进风格编写,每层缩进使用一个制表位(TAB),类定义、方法都应顶格书写;源程序建议使用英文书写,尽量不含有中文。

每行不超过80字符。

对于较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读;循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分;左花括号要另起一行,不能跟在上一行的行末;一个变量定义占一行,一个语句占一行;对独立的程序块之间、变量说明之后必须加空行;在结构成员赋值等情况,等号对齐,最少留一个空格;若函数或过程中的参数较长,则要进行适当的划分。

形参的排序风格:最常使用的参数放在第一位;输入参数列表应放在输出参数列表的左边;将通用的参数放在特殊的参数的左边。

2-命名规范应用程序的命名“系统简称”+模块名称子模块的命名每个子模块的名字应该由描述模块功能的1-3以单词组成。

每个单词的首字母应大写。

在这些单词中可以使用一些较通用的缩写。

变量的命名变量的命名的基本原则是使得变量的含义能够从名字中直接理解。

可以用多个英文单词拼写而成,每个英文单词的首字母要大写,其中英文单词有缩写的可用缩写;变量的前缀表示该变量的类型;对于作用域跨越10行以上的变量名称不能少于4个字符,除循环变量,累加变量外不得使用I、j、k等名称的变量。

变量分为取全局变量和局部变量,对于全局变量以加前缀“g_”来区分。

使用有意义的英语单词,使用大小写分隔,每个单词的第一个字母为大写考虑到习惯性和简洁性,对于按常规使用的局部变量允许采用极短的名字,如用n、i作为循环变量,p、q作为指针等。

另外,要注意的是:全局变量在程序中不要定义太多,能用局部变量的就用局部变量。

如果要使用相关的变量,建议采用类的方式或者结构的方式存放,以减少具体变量的个数。

常量的命名常量所有的字母均为大写。

并且单词之间使用下划线”_”隔开。

c语言编程规范

c语言编程规范

c语言编程规范C语言编程规范是指在使用C语言进行编程时应该遵循的一系列规定和标准。

在编写C语言程序时,遵循统一的编程规范可以提高代码的可读性、可维护性、可移植性和可靠性。

下面是一些常见的C语言编程规范,供大家参考和遵循。

1. 命名规范在C语言中,变量、函数、常量、宏等的命名应具有一定的规范性,以方便他人理解和阅读代码。

一般来说,命名应该尽量做到以下几点:- 变量和函数名使用小写字母,如果是多个单词组成,可以使用下划线 `_` 进行连接,如 `my_variable`。

- 宏常量使用全大写字母,并使用下划线 `_` 进行连接,如`MAX_SIZE`。

- 类型名和结构体名使用首字母大写的驼峰命名法,如 `MyStruct`。

- 全局变量和静态变量以 `g_` 开头,如 `g_count`。

- 局部变量使用有意义的名词或者简洁明了的单词缩写,如 `i` 表示整数变量,`ptr` 表示指针变量等。

2. 缩进与对齐在书写代码时,正确的缩进和对齐可以提高代码的可读性,让代码结构更加清晰。

通常使用4个空格进行缩进,并且在各个代码块之间使用空行进行分隔。

3. 注释规范注释是代码中必不可少的一部分,它可以解释代码的功能、逻辑和用法,便于其他人阅读和理解。

在编写注释时应尽量做到以下几点:- 使用自然语言进行注释,注释的内容要清晰明了,让其他开发人员容易理解。

- 对于复杂的逻辑或者算法,可以在代码旁边用注释进行解释。

- 对于不常见的技术或者特殊情况,可以在代码中加上注释进行说明。

- 尽量避免使用废弃的注释,及时更新和维护注释。

4. 函数规范函数是程序中的基本组成单元,编写规范的函数可以提高代码的可读性和可维护性。

在编写函数时应尽量做到以下几点:- 函数应该有明确的功能和目的,并且函数名要能够准确反映其功能。

- 函数的参数应该尽量避免过多,如果参数较多,可以考虑使用结构体传递参数。

- 函数应该尽量遵循单一职责原则,即一个函数只完成一个功能。

c程序书写规范

c程序书写规范

c,,程序书写规范篇一:C语言书写规范语言书写规范符号命名规则符号名包括模块名、常量名、标号名、子程序名等。

这些名字应该能反映它所代表的实际东西,具有一定的意义,使其能够见名知义,有助于对程序功能的理解。

命名采用匈牙利命名法。

规则如下:(1)所有宏定义、枚举常数和const变量,用大写字母命名。

在复合词里用下划线隔开每个词。

(2)复合词中每个单词的第一个字母大写。

除了规则以外,避免使用下划线。

(3)类、类型定义和枚举型名的第一个字母大写。

(4)函数名是复合词的,第一个词采用全部小写,随后每个单词采用第一个字母大写,其它字母小写方式;如果是单个词的,采用全部小写方式。

(5)循环变量可采用i, j, k等,不受上述规则限制。

(6) 类的成员变量应采用m_开头。

(7) 全局变量词头为g_ 。

(8) 临时变量词头为tmp_ 。

(9) 对结构体内的变量命名, 遵循变量的具体含义命名原则(10)用小写字母的前缀表示变量的类型,前缀的下一个字母用大写。

表 1词头类型词头类型ch char l longi integer u unsignedb boolean p pointerf float lp long pointerd double s stringst structure sz ASCII stringby byte n short intH handle x,y 分别为x,y坐标dw DWORD fn function表 2词头变量名词头变量名task task sig signalsb binary semaphores wd watchdog sm mutual exclusionsemaphores tm timersc counting semaphores msg message pipe pipe例:#define ARRAY_SIZE 24 /*规则*/int g_iFlag;class MyClass /*规则*/{};void someFunc( ) /*规则和*/{.2.Q/ECC/BJ 010—XXint nArray[ARRAY_SIZE];unsigned char uchByte;char szName[ ];char *pszName = szName;}(11)有些词头(如p和u)可以和其它词头组合。

C语言格式书写要求规范

C语言格式书写要求规范

C语言书写规指南第1章文件结构每个C程序通常分为两个文件。

一个文件用于保存程序的声明(declaration),称为头文件。

另一个文件用于保存程序的实现(implementation),称为定义(definition)文件。

C程序的头文件以“.h”为后缀,C程序的定义文件以“.c”为后缀。

1.1和版本的声明和版本的声明位于头文件和定义文件的开头(参见示例1-1),主要容有:(1)信息。

(2)文件名称,标识符,摘要。

(3)当前版本号,作者/修改者,完成日期。

(4)版本历史信息。

/**Copyright(c)2001,大学物理学院无线电*Allrightsreserved.**文件名称:filename.h*文件标识:*摘要:简要描述本文件的容**当前版本:1.1*作者:输入作者(或修改者)名字*完成日期:2007年7月20日**取代版本:1.0*原作者:输入原作者(或修改者)名字*完成日期:2007年5月10日*/示例1-1和版本的声明1.2头文件的结构头文件由三部分容组成:(1)头文件开头处的和版本声明(参见示例1-1)。

(2)预处理块。

(3)函数和类结构声明等。

假设头文件名称为SCL_SPI.h,头文件的结构参见示例1-2。

【规则1-2-1】为了防止头文件被重复引用,应当用#ifndef/#define/#endif结构产生预处理块。

【规则1-2-2】用#include <filename.h>格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。

【规则1-2-3】用#include “filename.h”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。

【规则1-2-4】#include 后面使用TAB键控制排版。

【规则1-2-5】头文件中只存放“声明”而不存放“定义”【规则1-2-6】全局变量在头文件中声明,在.c文件中定义.h extern in tvalue; 声明。

华为C语言规范

华为C语言规范
¹1-2:相对独立的程序块之间、变量说明之后必须加空行。 示例:如下例子不符合规范。 if (!valid_ni(ni)) { ... // program code } repssn_ind = ssn_data[index].repssn_index; repssn_ni = ssn_data[index].ni;
软件编程规范总则
&& (n7stat_stat_item_valid (stat_item)) && (act_task_table[taskno].result_data != 0));
1 排版
仅供内部使用 3
软件编程规范总则
1 排版
¹1-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低 优先级操作符处划分新行,操作符放在新行之首。
示例: (1) 逗号、分号只在后面加空格。 int a, b, c;
仅供内部使用 6
软件编程规范总则
1 排版
(2)比较操作符, 赋值操作符"="、 "+=",算术操作符"+"、"%",逻辑操作符"&&"、 "&",位域操作符"<<"、"^"等双目操作符的前后加空格。 if (current_time >= MAX_TIME_VALUE) a = b + c; a *= 2; a = b ^ 2;
应如下书写 if (!valid_ni(ni)) {
... // program code }
repssn_ind = ssn_data[index].repssn_index; repssn_ni = ssn_data[index].ni;

经典C编程规范完整篇

经典C编程规范完整篇

Input:
// 输入参数说明,包括每个参数的作
// 用、取值说明及参数间关系。
Output:
// 对输出参数的说明。
Return:
// 函数返回值的说明
Others:
// 其它说明
*************************************************/
C语言编程规范
2 注释
n7stat_flash_act_duration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER + index, stat_object );
1-6:不允许把多个短语句写在一行中,即一行只写一条语句。
C语言编程规范
1 排版
1-7:if、for、do、while、case、switch、default等语句自占一行,且if、for、 do、while等语句的执行语句部分无论多少都要加括号{}。
File name:
// 文件名
Author:
Version:
Date: // 作者、版本及完成日期
Description: // 用于详细说明此程序文件完成的主要功能,与其他模块
// 或函数的接口,输出值、取值范围、含义及参数间的控
// 制、顺序、独立或依赖等关系
Others:
// 其它内容的说明
1 排版
1-5:若函数或过程中的参数较长,则要进行适当的划分。 示例: n7stat_str_compare((BYTE *) & stat_object,
(BYTE *) & (act_task_table[taskno].stat_object), sizeof (_STAT_OBJECT));

经典C编程规范完整篇

经典C编程规范完整篇
02
2 注释
C语言编程规范
注释
1
2-1:一般情况下,源程序有效注释量必须在20%以上。
2
C语言编程规范
2 注释
C语言编程规范
/************************************************* Copyright (C), 1988-1999, Huawei Tech. Co., Ltd. File name: // 文件名 Author: Version: Date: // 作者、版本及完成日期 Description: // 用于详细说明此程序文件完成的主要功能,与其他模块 // 或函数的接口,输出值、取值范围、含义及参数间的控 // 制、顺序、独立或依赖等关系 Others: // 其它内容的说明 Function List: // 主要函数列表,每条记录应包括函数名及功能简要说明 1. .... History: // 修改历史记录列表,每条修改记录应包括修改日期、修改 // 者及修改内容简述 1. Date: Author: Modification: 2. ... *************************************************/
应如下书写 for (...) { ... // program code } if (...) { ... // program code } void example_fun( void ) { ... // program code }
C语言编程规范
1 排版
1-11:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。 说明:采用这种松散方式编写代码的目的是使代码更加清晰。 由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格.如括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在C/C++语言中括号已经是最清晰的标志了。 在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。
  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

C语言书写规范指南第1章文件结构每个C程序通常分为两个文件。

一个文件用于保存程序的声明(declaration),称为头文件。

另一个文件用于保存程序的实现(implementation),称为定义(definition)文件。

C程序的头文件以“.h”为后缀,C程序的定义文件以“.c”为后缀。

1.1版权和版本的声明版权和版本的声明位于头文件和定义文件的开头(参见示例1-1),主要内容有:(1)版权信息。

(2)文件名称,标识符,摘要。

(3)当前版本号,作者/修改者,完成日期。

(4)版本历史信息。

/**Copyright(c)2001,吉林大学物理学院无线电*Allrightsreserved.**文件名称:filename.h*文件标识:*摘要:简要描述本文件的内容**当前版本:1.1*作者:输入作者(或修改者)名字*完成日期:2007年7月20日**取代版本:1.0*原作者:输入原作者(或修改者)名字*完成日期:2007年5月10日*/示例1-1版权和版本的声明1.2头文件的结构头文件由三部分内容组成:(1)头文件开头处的版权和版本声明(参见示例1-1)。

(2)预处理块。

(3)函数和类结构声明等。

假设头文件名称为SCL_SPI.h,头文件的结构参见示例1-2。

【规则1-2-1】为了防止头文件被重复引用,应当用#ifndef/#define/#endif结构产生预处理块。

【规则1-2-2】用#include <filename.h>格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。

【规则1-2-3】用#include “filename.h”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。

【规则1-2-4】#include 后面使用TAB键控制排版。

【规则1-2-5】头文件中只存放“声明”而不存放“定义”【规则1-2-6】全局变量在头文件中声明,在.c文件中定义.h extern in tvalue; 声明。

.c in tvalue=0x10; 定义。

【规则1-2-7】局部变量在.c中定义(static)unsigned in tvalue; 定义。

//版权和版本声明见示例1-1,此处省略。

#ifndef SCL_SPI_H //防止SCL_SPI.h被重复引用#define SCL_SPI_H#include <p30f6014A.h> //引用标准库的头文件…#include “SCL_CAN.h”//引用非标准库的头文件…void Function1(…);//全局函数声明…extern unsign int value;//全局变量声明#endif示例1-2C头文件的结构1.3定义文件的结构定义文件有三部分内容:(1)定义文件开头处的版权和版本声明(参见示例1-1)。

(2)对一些头文件的引用。

(3)程序的实现体(包括数据和代码)。

假设定义文件的名称为SCL_SPI.c,定义文件的结构参见示例1-3。

//版权和版本声明见示例1-1,此处省略。

#include“SCL_SPI.h” //引用头文件…//全局变量定义unsign int value = 0x10;//全局函数的实现体void Function1(…){…}示例1-3C定义文件的结构1.4头文件的作用早期的编程语言如Basic、Fortran没有头文件的概念,C语言的初学者虽然会用使用头文件,但常常不明其理。

这里对头文件的作用略作解释:(1)通过头文件来调用库功能。

在很多场合,源代码不便(或不准)向用户公布,只要向用户提供头文件和二进制的库即可。

用户只需要按照头文件中的接口声明来调用库功能,而不必关心接口怎么实现的。

编译器会从库中提取相应的代码。

(2)头文件能加强类型安全检查。

如果某个接口被实现或被使用时,其方式与头文件中的声明不一致,编译器就会指出错误,这一简单的规则能大大减轻程序员调试、改错的负担。

1.5目录结构如果一个软件的头文件数目比较多(如超过十个),通常应将头文件和定义文件分别保存于不同的目录,以便于维护。

例如可将头文件保存于include 目录,将定义文件保存于source目录(可以是多级目录)。

如果某些头文件是私有的,它不会被用户的程序直接引用,则没有必要公开其“声明”。

为了加强信息隐藏,这些私有的头文件可以和定义文件存放于同一个目录。

第2章程序的版式版式虽然不会影响程序的功能,但会影响可读性。

程序的版式追求清晰、美观,是程序风格的重要构成因素。

可以把程序的版式比喻为“书法”。

好的“书法”可让人对程序一目了然,看得兴致勃勃。

差的程序“书法”如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加。

请程序员们学习程序的“书法”,弥补大学计算机教育的漏洞,实在很有必要。

2.1空行空行起着分隔程序段落的作用。

空行得体(不过多也不过少)将使程序的布局更加清晰。

空行不会浪费内存,虽然打印含有空行的程序是会多消耗一些纸张,但是值得。

所以不要舍不得用空行。

【规则2-1-1】在每个函数定义结束之后都要加空行。

参见示例2-1(a)【规则2-1-2】在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。

参见示例2-1(b)//空行void Function1(…){…}//空行void Function2(…){…}示例2-1(a)函数之间的空行//空行while (condition){statement1;//空行if (condition){statement2;}else{statement3;}//空行statement4;}示例2-1(b)函数内部的空行2.2代码行【规则2-2-1】一行代码只做一件事情,如只定义一个变量,或只写一条语句。

这样的代码容易阅读,并且方便于写注释。

【规则2-2-2】if、for、while、do等语句自占一行,执行语句不得紧跟其后。

不论执行语句有多少都要加{}。

这样可以防止书写失误。

示例2-2(a)为风格良好的代码行,示例2-2(b)为风格不良的代码行。

【建议2-2-1】尽可能在定义变量的同时初始化该变量(就近原则)如果变量的引用处和其定义处相隔比较远,变量的初始化很容易被忘记。

如果引用了未被初始化的变量,可能会导致程序错误。

本建议可以减少隐患。

例如int width = 10; //定义并初绐化widthint height = 10; //定义并初绐化heightint depth = 10; //定义并初绐化depth使用TAB键控制距离2.3代码行内的空格【规则2-3-1】关键字之后要留空格。

象const、virtual、inline、case等关键字之后至少要留一个空格,否则无法辨析关键字。

象if、for、while等关键字之后应留一个空格再跟左括号‘(’,以突出关键字。

【规则2-3-2】函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别。

【规则2-3-3】‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。

【规则2-3-4】‘,’之后要留空格,如Function(x,y,z)。

如果‘;’不是一行的结束符号,其后要留空格,如for (initialization; condition; update)。

【规则2-3-5】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。

【规则2-3-6】一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符)等前后不加空格。

【规则2-3-7】象“[]”、“.”、“->”这类操作符前后不加空格。

【建议2-3-1】对于表达式比较长的for语句和if语句,为了紧凑起见可以适当地去掉一些空格,如for(i=0;i<10;i++)和if((a<=b)&&(c<=d))void Func1(int x,int y,int z); //良好的风格void Func1 (int x,int y,int z); //不良的风格if (year >= 2000) //良好的风格if(year>=2000) //不良的风格if ((a>=b) && (c<=d)) //良好的风格if(a>=b&&c<=d) //不良的风格for (i=0; i<10; i++) //良好的风格for(i=0;i<10;i++) //不良的风格for(I = 0; I < 10; I++) //过多的空格x = a < b ? a : b; //良好的风格x=a<b?a:b; //不好的风格int *x = &y; //良好的风格int*x=&y; //不良的风格array[5] = 0; //不要写成array [ 5 ] = 0;a.Function(); //不要写成a . Function();b->Function(); //不要写成b -> Function();2.4对齐【规则2-4-1】程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。

【规则2-4-2】{}之内的代码块在‘{’右边一个TAB键处左对齐。

示例2-4(a)为风格良好的对齐,示例2-4(b)为风格不良的对齐。

void Function (int x) {…//programcode }Void Function(intx){ …//programcode}if (condition){…//programcode }else{…//programcode }if(condition){…//programcode}else{…//programcode }for (initialization; condition; update) {…//programcode}for(initialization;condition;update){ …//programcode}while (condition) {…//programcode }while(condition){ …//programcode }如果出现嵌套的{},则使用缩进对齐,如:{…{…}…}示例2-4(a)风格良好的对齐示例2-4(b)风格不良的对齐2.5长行拆分【规则2-5-1】代码行最大长度宜控制在70至80个字符以内。

代码行不要过长,否则眼睛看不过来,也不便于打印。

相关文档
最新文档