1 / 23
文档名称:

软件开发命名规范.docx

格式:docx   大小:68KB   页数:23页
下载后只包含 1 个 DOCX 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

软件开发命名规范.docx

上传人:guoxiachuanyue011 2022/6/5 文件大小:68 KB

下载得到文件列表

软件开发命名规范.docx

文档介绍

文档介绍:软件开发规范
C++命名规范
在研究项目团队协作开发的情况下(这里的团队协作也适合于应用项目的开发),编程时应该强调的一个重要方面是程序的易读性,在保证软件速度等性能指标能满足用户需求的情况下,能让其他程序员容易读懂你所编写的程序。若研ne”后以TAB键代替SPACE键做空格;如果头文件名称是由多个单词组成,则各单词间以下划线“_”连接,例如有头文件名称为“”,则定义如下:“#ifndef_FILE_SYSTEM_H_”;
用#include<>格式来引用标准库的头文件(编译器将从标准库目录开始搜索);
用#include“”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索);
头文件中只存放“声明”而不存放“定义”;头文件中应包含所有定义文件所定义的函数声明,如果一个头文件对应多个定义文件,则不同定义文件内实现的函数要分开声明,并作注释以解释所声明的函数从属于那一个定义文件;宏定义和函数声明分离,在两个头文件中定义,如果没有类成员函数,可以将类和结构的定义与函数声明分离,也就是说一个头文件专用于宏定义,一个头文件专用于类和结构的定义,一个头文件专用于函数声明;
在C++语法中,类的成员函数可以在声明的同时被定义,并且自动成为内联函数。这虽然会带来书写上的方便,但却造成了风格不一致,弊大于利。建议将成员函数的定义与声明分开,不论该函数体有多么小。
头文件的结构如下:
//文件信息声明见示例1-1,此处省略。
#ifndef_FILE_SYSTEM_H_//avoidreferencingthefilefilesystemrepeat#define_FILE_SYSTEM_H_
#include<〉
//referencestandardheadfile
#include“"
//referencenon-standardheadfile
voidFunctionl(…);
//globalfunctiondeclare
定义文件的结构
定义文件有三部分内容:
(1)定义文件开头处的文件信息声明(参见示例1-1);
(2)对一些头文件的引用;
(3)程序的实现体(包括数据和代码)。
,定义文件的结构参见示例1-3。//文件信息声明见示例1-1,此处省略。
#include“”/referenceaheadfile
•••
//globalfunctionrealization
voidFunctionl(…)
{
•••
}
//classmemberfunctionrealization
voidCBox::Draw(…)
{
•••
}
示例l-3C++/C定义文件的结构
头文件的作用
早期的编程语言如Basic、Fortran没有头文件的概念,C++/C语言的初学者虽然会用使用头文件,但常常不明其理。这里对头文件的作用略作解释:
(1)通过头文件来调用库功能。在很多场合,源代码不便(或不准)向用户公布,只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能,而不必关心接口怎么实现的。编译器会从库中提取相应的代码;
(2)头文件能加强类型安全检查。如果某个接口被实现或被使用时,其方式与头文件中的声明不一致,编译器就会指出错误,这一简单的规则能大大减轻程序员调试、改错的负担。
目录结构
如果一个软件的头文件数目比较多(如超过十个),通常应将头文件和定义文件分别保存于不同的目录,以便于维
护。
例如可将头文件保存于include目录,将定义文件保存于source目录(可以是多级目录)。如果某些头文件是私有的,它不会被用户的程序直接引用,则没有必要公开其“声明”。为了加强信息隐藏,这些私有的头文件可以和定义文件存放于同一个目录。
命名规则
比较著名的命名规则当推“匈牙利”命名法,该命名规则的主要思想是“在变量和函数名中加入前缀以增进人们对程序的理解”例如所有的字符变量均以ch为前缀,若是指针变量则追加前缀p。如果一个变量由ppch开头,则表明它是指向字符指针的指针。
“匈牙利”法最大的缺点是烦琐,例如
inti,j,k;
floatx,y,z;倘若采用“匈牙利”命名规则,

最近更新

2024年应聘店长自我介绍(热) 12页

2024年应届毕业大学生求职信 6页

我国汽车特许经销商竞争力评估及实证研究的开.. 2页

2024年庆中秋的慰问信4篇 6页

2024年幼师求职信6篇 9页

我国国家助学贷款政策文本分析的开题报告 2页

我国商业银行海外并购绩效研究的开题报告 2页

我国农村殡葬用地管理法律问题研究的开题报告.. 2页

2024年幼儿教师个人成长年度总结(精选41篇).. 107页

我国公立医院职工组织认同与离职倾向的关系中.. 2页

我国公共投资对中小企业发展的影响研究的开题.. 2页

2024年幼儿安全工作计划模板汇总7篇 27页

2024年幼儿大班工作计划15篇 44页

我国中小外企人力资源管理外包风险对策研究的.. 2页

2024年幼儿园运动会主持词结束语 11页

2024年幼儿园读书节活动倡议书(精选16篇) 23页

2024年幼儿园见习报告范文 9页

2024年幼儿园老师辞职报告必备(15篇) 22页

慢性炎性脱髓鞘性多发性神经病的临床及神经电.. 2页

恩替卡韦分散片人体生物利用度和生物等效性研.. 2页

急性白血病中DNMT3A基因的突变和表达研究的开.. 2页

大件运输路线勘测报告 2页

摩托车产业人工智能应用案例 29页

寓言故事(精选30篇) 32页

2024年上海高考志愿填报时间及指南 3页

关于催人泪下七字祭父诗四篇 3页

交通肇事社区矫正人员思想汇报 5页

呓语歌词--毛不易(共1页) 1页

标准路勘模板 3页

《莲花生大士全传》 44页