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. 头文件引用:在程序开始的地方引用需要使用的头文件,以便程序能够访问所需的函数和变量声明。

2. 定义全局变量:在函数之外声明全局变量,以便多个函数能够访问并共享这些变量。

3. 函数声明:在程序开始或函数最前面声明要使用的函数,以便编译器可以识别函数的存在并进行正确的编译。

4. 主函数:每个C程序都必须包含一个主函数,它是程序的入口点。

主函数一般形式为 "int main() { ... }"。

5. 注释:使用注释向代码中添加说明。

注释可以单行以"//"开头,也可以使用多行注释 "/\* \*/"。

6. 变量定义和赋值:在函数中定义和初始化变量。

变量定义时可以直接赋值或者在后续语句中赋值。

7. 控制流语句:使用if、else、switch等控制流语句来进行条件判断和根据不同条件执行不同的代码块。

8. 循环语句:使用for、while、do-while等循环语句来重复执行某段代码。

9. 函数定义:在程序中定义自定义函数,以便在需要的地方调用这些函数。

函数定义的一般形式为 "返回类型函数名(参数列表) { ... }"。

10. 返回语句:使用return语句来从函数中返回一个值,并将控制权交还给调用函数。

11. 文件操作:通过使用标准库中的文件操作函数来读取和写入文件。

12. 错误处理:对于可能发生错误的操作,需要进行适当的错误处理,例如使用条件判断来检查是否发生错误。

总的来说,C程序的结构和书写规则包括头文件引用、全局变量定义、函数声明、主函数、注释、变量定义和赋值、控制流语句、循环语句、函数定义、返回语句、文件操作和错误处理等要素。

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语言规范
* 编程人员 : 宋毅红
* 编程时间 : 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. 错误处理:在编写代码时应该考虑错误处理。

  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、**文件名称:*文件标识:*摘要:简要描述本文件的内容**当前版本: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 <>格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。

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

【规则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) {…//progr amcode }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、5长行拆分【规则2-5-1】代码行最大长度宜控制在70至80个字符以内。

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

【规则2-5-2】长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。

相关文档
最新文档