c语言书写标准Word下载.docx
- 文档编号:14989730
- 上传时间:2022-10-26
- 格式:DOCX
- 页数:16
- 大小:26.44KB
c语言书写标准Word下载.docx
《c语言书写标准Word下载.docx》由会员分享,可在线阅读,更多相关《c语言书写标准Word下载.docx(16页珍藏版)》请在冰豆网上搜索。
(8)临时变量词头为tmp_。
(9)对结构体内的变量命名,遵循变量的具体含义命名原那么
(10)用小写字母的前缀表示变量的类型,前缀的下一个字母用大写。
表1
词头类型词头类型
chcharllong
iintegeruunsigned
bbooleanppointer
ffloatlplongpointer
ddoublesstring
ststructureszASCIIstring
bybytenshortint
Hhandlex,y别离为x,y坐标
dwDWORDfnfunction
表2
词头变量名词头变量名
tasktasksigsignal
sbbinarysemaphoreswdwatchdog
smmutualexclusion
semaphorestmtimer
sccountingsemaphoresmsgmessage
pipepipe
例:
#defineARRAY_SIZE24/*规那么*/
intg_iFlag;
classMyClass/*规那么*/
{
};
voidsomeFunc()/*规那么和*/
.2.
Q/ECC/BJ010—XX
intnArray[ARRAY_SIZE];
unsignedcharuchByte;
charszName[];
char*pszName=szName;
}
(11)有些词头(如p和u)能够和其它词头组合。
WDOG_IDwdId;
WDOG_IDg_wdId;
/*全局watchdogId,故以g_开头*/
名字的长度一样不要太长或太短。
太长的名字会增加工作量,使程序逻辑流程变得模糊;
太短的名字无法表达符号的实际意义。
约定长度范围:
3-31;
数据和函数说明
数听说明顺序应当标准化,使数据属性容易查找,也有利于测试、排错和保护。
说明的前后顺序应固定,应按逻辑功能排序,逻辑功能块内建议采纳以下顺序:
整型说明、实型说明、字符说明、逻辑量说明。
若是设计了一个复杂的数据结构,应当通过注释对其变量的含义、用途进行说明。
在函数的声明中利用异样声明。
如:
voidf()throw(toobig,toosmall,divzero);
在声明一个函数时,将它所抛出的异样列出,便于函数的利用者了解可能会发生哪些异样。
程序注释
程序注释是程序员与往后的程序读者之间通信的重要手腕之一,注释分为文件注释、函数注释和功能注释。
正规程序的注释应注意:
——注释行的数量占到整个源程序的1/3到1/2。
文件注释位于整个源程序的最开始部份,注释后空两行开始程序正文。
它包括:
——程序题目。
——目的、功能说明。
——文件作者、最后修改日期等说明。
./********************************************************************(空一行)
题目:
功能:
测试VxWorks的各类系统挪用.
说明:
该程序测试各类VxWorks的系统挪用函数。
包括任务(taks)的创建、挂起及任务间通过信号灯实现同步,通过消息队列进行通信。
程序创建了两个任务:
一个高优先级的任务和一个低优先级的任务。
两个任务间通过一个二进制的信号灯进行同步,通过消息队列进行通信。
当前版本:
修改信息:
John,InitialVersion
Tom,Bugxxxxfixed
**************************************************************/
(空2行,开始程序正文)
函数注释通常置于每函数或进程的开头部份,它应当给出函数或进程的整体说明关于明白得程序本身具有引导作用。
一样包括如下条款:
——模块题目。
——有关本模块功能和目的的说明。
——挪用格式
——接口说明:
包括输入、输出、返回值、异样。
——算法。
若是模块中采纳了一些复杂的算法。
file:
//(注释开头应和上一函数空两行)
(注释开头与上一函数最后一行距离两行)
/********************************************************************题目:
assignmentComplete
功能:
BSC=>
MSC消息生成函数,生成assignment_complete指配完成消息(BSMAP消息).格式:
intassignmentComplete(intiCellId,intiServiceChannnelNum,char*pszMSGData)throw(exception1,exception2)
输入:
intiCellId:
MS所在的小区识别
iCellId取值:
0x00-——0xff.4.
intiServiceChannnelNum:
MS所占的业务信道号码
输出:
char*pszMSGData:
指配完成消息数据
返回值:
0x00正常
异样:
exception1异样情形1,exception2异样情形2
********************************************************************/(注释后直接开始程序正文,不空行。
)
功能性注释嵌在源程序体中,用于描述其后的语句或程序段做什么工作,也确实是说明下面要做什么,或是执行了下面的语句会怎么样。
而不要说明下面怎么做,因为说明怎么做常常与程序本身是重复的。
例:
/*把amount加到total中*/
total=amount+total;
如此的注释仅仅是重复了下面的程序,关于明白得它的工作并无什么作用。
而下面的注释,有助于读者明白得。
/*将每一个月的销售额amount加到年销售额total中*/
函数编写应尽可能短小精悍,一样不超过两屏,以便于调试和明白得。
语句结构
为保证语句结构的清楚和程序的可读性,在编写软件程序时应注意以下几个方面的问题:
篇二:
关于C语言编程书写标准的规那么和建议
关于C语言编程书写标准的规那么和建议
一、头文件
一、头文件开头处的版权和版本声明。
二、预处置块。
3、函数和类结构声明等。
?
头文件由三部份内容组成:
?
【规那么】为了避免头文件被重复引用,应当用ifndef/define/endif结构产生预处置块。
【规那么】用#include格式来引用标准库的头文件(编译器将从标准库目录开始搜索).
【规那么】用#include“”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)
【建议】头文件中只寄存“声明”而不寄存“概念”
【建议】不提倡利用全局变量,尽可能不要在头文件中显现象externintvalue这种声明。
二、程序的版式
空行
【规那么】在每一个类声明以后、每一个函数概念终止以后都要加空行。
【规那么】在一个函数体内,逻揖上紧密相关的语句之间不加空行,其它地址应加空行分隔。
代码行
【规那么】一行代码只做一件情形,如只概念一个变量,或只写一条语句。
如此的代码容易阅读,而且方便于写注释。
【规那么】if、for、while、do等语句自占一行,执行语句不得紧跟其后。
不论执行语句有多少都要加{}。
如此能够避免书写失误。
【建议】尽可能在概念变量的同时初始化该变量(就近原那么)
代码行内的空格
【规那么】关键字以后要留空格。
象const、virtual、inline、case等关键字以后至少要留一个空格,不然无法辨析关键字。
象if、for、while等关键字以后应留一个空格再跟左括号‘(’,以突出关键字。
【规那么】函数名以后不要留空格,紧跟左括号‘(’,以与关键字区别。
【规那么】‘(’向后紧跟,‘)’、‘,’、‘;
’向前紧跟,紧跟处不留空格。
【规那么】‘,’以后要留空格,如Function(x,y,z)。
若是‘;
’不是一行的终止符号,其后要留空格。
【规那么】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=”“>
=”、“ ?
【规那么】一元操作符如“!
”、“~”、“++”、“--”、“&
”(地址运算符)等前后不加空格。
【规那么】象“[]”、“.”、“->
”这种操作符前后不加空格。
【建议】关于表达式比较长的for语句和if语句,为了紧凑能够适本地去掉一些空格,如for(i=0;
i ?
【规那么】程序的分界符‘{’和‘}’应独占一行而且位于同一列,同时与引用它们的语句左对齐。
【规那么】{}之内的代码块在‘{’右边数格处左对齐。
长行拆分
【规那么】代码行最大长度宜操纵在70至80个字符之内。
代码行不要太长,不然眼睛看只是来,也不便于打印。
【规那么】长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。
拆分出的新行要进行适当的缩进,使排版整齐,语句可读。
注释
注释符为“/*?
*/”。
C++语言中,程序块的注释常采纳“/*?
*/”,行注释一样采纳“//?
”。
注释通经常使用于:
版本、版权声明;
函数接口说明
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 语言 书写 标准