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语言代码规范,以帮助开发者编写高质量的C语言程序。

一、代码格式1. 缩进:使用四个空格进行缩进,不要使用制表符。

这样可以保证在不同编辑器或显示器上显示的代码缩进一致。

2. 行长度限制:每行代码应尽量保持在80个字符以内,超过限制的代码可以进行适当换行。

换行时要注意保持代码的清晰可读性,一般可以采用缩进来表达代码的层次关系。

3. 大括号:大括号的位置应该和相关语句对齐,且起始的大括号应该放在语句所在行的末尾,而不是单独另起一行。

4. 空格和空行:在适当的情况下使用空格和空行可以提高代码的可读性。

例如,在运算符和操作数之间使用空格,不同的代码块之间使用空行进行分割等。

二、命名规范1. 变量名:使用有意义的变量名,尽量避免使用单个字符或简单的缩写表示变量。

变量名应该忠实地反映其所代表的含义。

2. 函数名:函数名应使用动词和名词的组合,具体描述函数的功能。

函数名应该清晰地表达其所完成的操作或所返回的结果。

3. 常量名:常量名使用全大写字母,并使用下划线进行分隔。

例如,MAX_LENGTH。

4. 类型名:类型名使用首字母大写的驼峰命名法,例如,StudentInfo。

5. 宏定义名:宏定义名使用全大写字母,并使用下划线进行分隔。

例如,PI。

三、注释规范1. 单行注释:使用"//"进行单行注释,注释符号后面应该留一个空格。

注释应该清晰明了,解释代码的用途或特殊处理等。

2. 多行注释:使用"/*"和"*/"进行多行注释。

多行注释通常用于解释一整块代码的功能或原理等。

3. 函数注释:在每个函数定义的上方加上函数注释,注释中应该包含函数的功能描述、输入参数的说明、返回值的含义以及可能抛出的异常等信息。

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语言程序书写格式

C语言程序书写格式
C语言程序书写格式
引导语:为了增强C语言的可读性,正确的书写格式就显得十分重要。

以下是店铺分享给大家的'C语言程序书写格式,希望大家喜欢!
例.习分析下列程序的输出结果:
程序内容如下:
Multiply(x,
y)
int
x,y;return(x,Y);
}main (){
int a,
b;a=5}
B=6;printf(
”%d\n”,
multiply
(a,b)
);
)
读者一定会发现这个程序不容易读懂。

主要是书写上没有按照习惯的格式。

语言书写要求比较自由,一般只要一个单词不得分开写,单词之间用空白符分隔,而空白符包含空格符、水平制表符和换行符等。

因此,例1. 3中的程序书写上并没有词法错误。

执行该程序后,会在屏幕上显示出如下结果:
30
如果将该程序重新书写一遍,如下所示。

例1. 4〕将例1. 3程序重新书写如下:
rnultiply(x,y)
Int,x,y;
{
return(x * y);

main()
{
Int a,b;
printf ("%d\n" , multiply La, b)); 【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. 确保操作符和操作数之间有正确的空格分隔。

例如,将操作符放置在操作数
之间,例如`a + b`。

3. 使用圆括号来明确指定运算顺序。

圆括号用于分组操作数,例如`(a + b) * c`。

在复杂的表达式中,使用圆括号可以防止运算顺序混淆。

4. 遵循运算符的优先级和结合性规则。

C语言中,不同的运算符具有不同的优
先级和结合性。

在表达式中,先计算优先级高的运算符,再计算优先级低的运算符。

如果有多个相同优先级的运算符,那么根据结合性从左到右或从右到左进行计算。

5. 使用适当的赋值规则。

在C语言中,使用单个等号(=)进行赋值操作。

例如,`x = 5`。

同时,也可以使用其他赋值运算符进行简化赋值操作,例如`x += 5`
等价于`x = x + 5`。

6. 避免重复运算。

在复杂的表达式中,避免重复计算同一个值,可以使用临时
变量来存储计算结果。

总之,在C语言中,正确书写表达式是保证程序正确性和可读性的重要因素。

遵循上述的书写规则可以帮助开发者编写出更加优雅和高效的代码。

c语言编程规范

c语言编程规范

c语言编程规范C语言编程规范(1000字)C语言作为一种广泛使用的编程语言,编写程序时应遵循一定的编程规范。

编程规范可以提高代码的可读性和维护性,减少错误和调试时间。

以下是一些常用的C语言编程规范。

1. 缩进和格式化:使用四个空格进行缩进,并在语句的开头和结尾留出适当的空格。

用大括号将代码块括起来,并将其包含的代码缩进四个空格。

例如:```cif (condition) {statement;}```2. 注释:对重要的代码块和函数进行注释,以便于其他开发人员阅读和理解代码。

注释应明确和简洁,并用英文书写。

例如:```c/* This function calculates the sum of two numbers */int sum(int a, int b) {return a + b;}```3. 命名规范:变量、函数和常量的命名应具有描述性,并使用小写字母和下划线分隔单词。

使用有意义的名称可以提高代码的可读性。

例如:```cint count; // 变量名用名词void print_hello(); // 函数名用动词const int MAX_LENGTH = 100; // 常量名全大写```4. 常量和宏定义:使用宏定义来定义常量和预处理指令,以便于代码维护和修改。

使用大写字母和下划线命名常量,并用宏定义来定义它们。

例如:```c#define MAX_LENGTH 100```5. 函数长度和复杂度:函数的长度应该控制在一定范围内,以提高代码的可读性和维护性。

通常推荐一个函数不超过30行代码,并且应该尽量避免过于复杂的控制流程。

如果一个函数超过了这个范围,可以考虑将其拆分为多个较小的函数。

6. 变量的声明和初始化:变量应在使用之前进行声明,并在声明时进行初始化。

声明时可以将相同类型的变量放在一起,并且可以将变量的声明放在函数体的开头。

例如:```cint main() {int foo, bar; // 变量声明int i = 0; // 变量声明和初始化...}```7. 错误处理:在编写代码时应该考虑错误处理。

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.避免使用全局变量,因为它们会增加代码的复杂性和不可预测性。

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语言编程规范C语言编程规范是指在使用C语言进行编程时应该遵循的一系列规定和标准。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

C语言程序代码编写规范

C语言程序代码编写规范

C语言程序代码编写规范一个好的程序编写规范是编写高质量程序的保证。

清晰、规范的源程序不仅方便阅读,更重要的是能够便于检查错误,提高调试效率,从而最终保证程序的质量和可维护性。

对于刚刚开始接触编程的初学者来说,尤其要遵循编程规范,培养良好的职业素养。

以下是一些最基本的代码编写规范。

1.命名规范(1)常量命名①符号常量的命名用大写字母表示,如#define LENGTH 10。

②如果符号常量由多个单词构成,两个不同的单词之间可以用下划线连接,如#define MAX_LEN 50。

(2)变量和函数命名①可以选择有意义的英文(小写字母)组成变量名,使读者看到该变量就能大致清楚其含义。

②不要使用人名、地名和汉语拼音。

③如果使用缩写,应该使用那些约定俗成的,而不是自己编造的。

④多个单词组成的变量名,除第一个单词外的其他单词首字母应该大写,如dwUserInputValue。

⑤对于初学者,函数命名可以采用FunctionName的形式。

2.代码书写规范(1)空格的使用①在逗号后面和语句中间的分号后面加空格,如int i,j;和for(i=0;i<n;i++)。

②在二目运算符的两边各留一个空格,如a>b 写成a > b③关键字两侧,如if()...,写成if() ...(2)缩进的设置根据语句间的层次关系采用缩进格式书写程序,每进一层,往后缩进一层。

有两种缩进方式,分别是使用Tab键和采用4个空格。

整个文件内部应该统一,不要混用Tab和4个空格,因为不同的编辑器对Tab键的处理方法不同。

(3)嵌套语句(语句块)的格式对于嵌套式的语句,即语句块(如if、while、for、switch等)应该包括在花括号中。

花括号的左括号应该单独占一行,并与关键字对齐。

建议即使语句块中只有一条语句,也应该使用花括号,这样可以使程序结构更清晰,也可以避免出错。

建议对比较长的程序块,在末尾的花括号后加上注释,以表明该语句块结束。

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语言结构和书写规则

scanf(“%d”, &num2);
printf(“max=%d\n”, max(num1, num2));
}
图1-2 函数体结构示意图
4.说明
(1)函数体中的变量定义语句,必须在所有可执行语句之前。
下面程序中变量定义语句“int max;”的位置是非法的:
14
C程序设计实践
main()
{ int x,y;
19
C程序设计实践
例如,下面就是一个空语句: ;
5. 复合语句 复合语句是由大括号括起来的一组(也可以是1条)语句构成。例 如:
main() { …… {……} /*复合语句。注意:右括号后不需要分号。*/ …… }
复合语句的性质: (1)在语法上和单一语句相同,即单一语句可以出现的地方,也可 以使用复合语句。 (2)复合语句可以嵌套,即复合语句中也可出现复合语句。
《 C程序设计试题汇编 》谭浩强 清华大学出版社
《 C程序设计题解与上机指导 》谭浩强 清华大学出版社
3
C程序设计实践 网上资源
https:// https://
4
C程序设计实践
C语言的重要地位
{ return( x>y ? x : y ); } main()
{ int num1,num2; printf(“Input the first integer number: ”); scanf(“%d”, &num1); printf(“Input the second integer number: ”); scanf(“%d”, &num2); printf(“max=%d\n”, max(num1, num2));
/*变量定义语句:定义2个整型变量x、y*/

C语言编程风格和规范

C语言编程风格和规范

C语言编程风格和规范C语言是一种广泛应用于系统级编程和嵌入式开发的高级编程语言。

为了保证代码的可读性和可维护性,程序员应当遵循一定的编程风格和规范。

本文将介绍一些常见的C语言编程风格和规范。

一、命名规范在C语言中,良好的命名风格可以提升代码可读性。

以下是一些常见的命名规范:1. 变量和函数名使用小写字母,单词之间用下划线(_)分隔,例如:my_variable。

2. 结构体和枚举类型采用首字母大写的驼峰命名法,例如:MyStruct。

3. 宏定义使用全大写字母,单词之间用下划线(_)分隔,例如:MY_MACRO。

二、缩进和空格良好的缩进和空格使用可以使代码结构清晰,提高可读性。

以下是一些常见的缩进和空格规范:1. 使用两个空格或者一个制表符进行代码缩进。

2. 操作符前后加空格,例如:a = b + c。

3. 函数名和左圆括号之间不加空格,例如:printf("Hello World")。

三、注释规范注释对于代码的理解和维护非常重要。

以下是一些关于注释的规范:1. 对于复杂的算法或者重要的函数,应当提供函数头部的注释来解释函数的功能、输入输出参数等。

2. 使用//或者/* ... */来添加注释,简洁明了。

3. 不要在注释中使用绝对的数字或者日期表示,应使用相对的描述,例如:3个元素或者最近更新。

四、函数和模块规范函数和模块的设计可以帮助提高代码的可读性和可维护性。

以下是一些相关的规范:1. 函数应当尽量短小,一个函数只做一件事情。

2. 函数应当有清晰的参数和返回值,避免使用全局变量。

3. 模块应当有清晰的接口定义和模块内部的实现,尽量减少对外部变量和函数的依赖。

五、错误处理规范良好的错误处理可以提高代码的健壮性和可靠性。

以下是一些常见的错误处理规范:1. 函数应当返回适当的错误码或者错误标志,用于外部处理错误情况。

2. 错误处理的代码应当尽量短小,避免嵌套过深的if语句。

3. 错误处理的输出信息应当清晰明了,帮助定位问题。

经典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)。

1.C语言书写规范1.1符号命名规则1.1.1符号名包括模块名、常量名、标号名、子程序名等。

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

命名采用匈牙利命名法。

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

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

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

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

(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 watchdogsm mutual exclusionsemaphores tm timersc counting semaphores msg messagepipe pipe例:#define ARRAY_SIZE 24 /*规则5.1.1.1*/int g_iFlag;class MyClass /*规则5.1.1.3*/{};void someFunc( ) /*规则5.1.1.2和5.1.1.4*/ {.2.Q/ECC/BJ 010—2001int nArray[ARRAY_SIZE];unsigned char uchByte;char szName[ ];char *pszName = szName;}(11)有些词头(如p和u)可以和其它词头组合。

例:WDOG_ID wdId;WDOG_ID g_wdId; /*全局watchdog Id,故以g_开头*/1.1.2名字的长度一般不要过长或过短。

过长的名字会增加工作量,使程序逻辑流程变得模糊;过短的名字无法表达符号的实际意义。

约定长度范围:3-31;1.2数据和函数说明1.2.1数据说明次序应当规范化,使数据属性容易查找,也有利于测试、排错和维护。

说明的先后次序应固定,应按逻辑功能排序,逻辑功能块内建议采用下列顺序:整型说明、实型说明、字符说明、逻辑量说明。

1.2.2如果设计了一个复杂的数据结构,应当通过注释对其变量的含义、用途进行说明。

1.2.3在函数的声明中使用异常声明。

如:void f() throw(toobig, toosmall, divzero);在声明一个函数时,将它所抛出的异常列出,便于函数的使用者了解可能会发生哪些异常。

1.3 程序注释1.3.1程序注释是程序员与日后的程序读者之间通信的重要手段之一,注释分为文件注释、函数注释和功能注释。

1.3.2正规程序的注释应注意:——注释行的数量占到整个源程序的1/3到1/2。

1.3.3文件注释位于整个源程序的最开始部分,注释后空两行开始程序正文。

它包括:——程序标题。

——目的、功能说明。

——文件作者、最后修改日期等说明。

例:./********************************************************************(空一行)标题: Demo.c功能: 测试VxWorks的各种系统调用.说明:该程序测试各种VxWorks的系统调用函数。

包括任务(taks)的创建、挂起及任务间通过信号灯实现同步,通过消息队列进行通讯。

程序创建了两个任务:一个高优先级的任务和一个低优先级的任务。

两个任务间通过一个二进制的信号灯进行同步,通过消息队列进行通讯。

当前版本:x.x修改信息:2000.06.05 John,Initial Version2000.07.05 Tom,Bug xxxx fixed**************************************************************/(空2行,开始程序正文)1.3.4 函数注释通常置于每函数或过程的开头部分,它应当给出函数或过程的整体说明对于理解程序本身具有引导作用。

一般包括如下条目:——模块标题。

——有关本模块功能和目的的说明。

——调用格式——接口说明:包括输入、输出、返回值、异常。

——算法。

如果模块中采用了一些复杂的算法。

例:file://(注释开头应和上一函数空两行)(注释开头与上一函数最后一行间隔两行)/********************************************************************标题:assignmentComplete功能:BSC=>MSC消息生成函数,生成assignment_complete指配完成消息(BSMAP消息) .格式:int assignmentComplete(int iCellId, int iServiceChannnelNum, char *pszMSGData)throw(exception1, exception2)输入:int iCellId: MS所在的小区识别iCellId取值:0x00-——0xff .4.Q/ECC/BJ 010—2001int iServiceChannnelNum:MS所占的业务信道号码输出:char * pszMSGData:指配完成消息数据返回值: 0x00正常异常:exception1异常情况1, exception2异常情况2********************************************************************/ ( 注释后直接开始程序正文,不空行。

)1.3.5功能性注释嵌在源程序体中,用于描述其后的语句或程序段做什么工作,也就是解释下面要做什么,或是执行了下面的语句会怎么样。

而不要解释下面怎么做,因为解释怎么做常常与程序本身是重复的。

例:/*把amount 加到total中*/total = amount + total;这样的注释仅仅是重复了下面的程序,对于理解它的工作并没有什么作用。

而下面的注释,有助于读者理解。

/*将每月的销售额amount加到年销售额total中*/total = amount + total;1.4 函数编写应尽可能短小精悍,一般不超过两屏,以便于调试和理解。

1.5语句结构为保证语句结构的清晰和程序的可读性,在编写软件程序时应注意以下几个方面的问题:——在一行内只写一条语句,并采用空格、空行和移行保证清楚的视觉效果。

——每一个嵌套的函数块,使用一个TAB缩进(可以设定为4个空格),大括号必须放在条件语句的下一行,单独成一行,便于匹对:如,有一段程序如下:for(i=1;iif(a[j]应写为for( i=1; i<>{t=1;for(j = i+1; j<>{if(a[i]<A[J])< p>t=j;if(t!=1){ .5.Q/ECC/BJ 010—2001work=a[t];a[t]=a[i];a[i]=work;}}}——文件之中不得存在无规则的空行,比如说连续十个空行。

一般来讲函数与函数之间的空行为2-3行;在函数体内部,在逻辑上独立的两个函数块可适当空行,一般为1-2行。

——程序编写首先应考虑清晰性,不要刻意追求技巧性而使得程序难以理解。

——每行长度尽量避免超过屏幕宽度,应不超过80个字符。

——除非对效率有特殊要求,编写程序要作到清晰第一,效率第二。

——尽可能使用函数库。

——尽量用公共过程或子程序去代替重复的功能代码段。

要注意,这个代码应具有一个独立的功能,不要只因代码形式一样便将其抽出组成一个公共过程或子程序。

——使用括号清晰地表达算术表达式和逻辑表达式的运算顺序。

如将x=a*b/c*d 写成x=(a*b/c)*d 可避免阅读者误解为x=(a*b)/(c*d)。

——避免不必要的转移。

——避免采用过于复杂的条件测试。

——避免过多的循环嵌套和条件嵌套。

——建议不要使用*=,^=, /=等运算符。

——一个函数不要超过200行。

一个文件应避免超过2000行。

——尽量避免使用go to语句。

——避免采用多赋值语句,如x = y = z ;——不鼓励采用?:操作符,如z = (a>b)?a:b;——不要使用空的if else 语句。

如if(cMychar >= ‘A’)if(cMychar <= ‘Z’)printf(“This is a letter \n”);elseprintf(“This is not a letter \n”);else到底是否定哪个if容易引起误解。

可通过加{}避免误解。

——尽量减少使用“否定”条件的条件语句。

如:把if( !( (cMychar<’0’) || (cMychar>’9’) ) )改为if( (cMychar>=’0’) && (cMychar<=’9’) )。

相关文档
最新文档