医疗器械软件编码管理规定.doc

PAGE\*Arabic1/NUMPAGES\*Arabic2

软件编码管理规定

目的

软件开发、测试、维护等活动过程中，为保证与软件代码有关的可靠性、可读性、可修改性、可维护性、一致性，保证程序代码的质量，继承软件开发成果，充分利用资源，提高程序的可继承性，使开发人员之间的工作成果可以共享，制定本文件。

适用范围

适用于公司软件产品的开发过程中软件编码过程的管理。

职责

研发负责人：负责本文件的实施和监督。

软件开发、测试及维护人员：应按照本文件的要求实施。

内容

4.1总体原则

①遵循开发流程，按策划的要求进行代码编写。

②代码的编写以实现设计的功能和性能为目标，要求正确完成设计要求的功能，达到设计的性能。

③程序具有良好的程序结构，提高程序的封装性，减低程序的耦合程度。程序可读性强，易于理解；方便调试和测试，可测试性好。易于使用和维护；良好的修改性、扩充性；可重用性强，移植性好。占用资源少，以低代价完成任务。

④在不降低程序的可读性的情况下，尽量提高代码的执行效率。

4.2BorlandC++Builder语言

4.2.1源程序的文件管理

4.2.1.1组织

每个程序文件单元通常都应由.cpp、.dfm和.h等文件组成，并将单元的公共声明部分放在.h文件中。划分单元主要是以类为依据，原则上每个较大的类都应为一个单独的单元，但在类较小且多个小类关系密切等情况下也可几个类共一个单元（建议仅对已经详细测试得较为通用的类采用）。

4.2.1.2命名

原程序文件命名采用有意义的格式。例如：对登录程序来说三个文件的命名应该是这样，.cpp的是Login.cpp.dfm的是Login.dfm.h的是Login.h

4.2.1.3文件结构

每个程序文件由标题、内容和附加说明三部分组成。①标题：文件最前面的注释说明，其内容主要包括：程序名，作者，版本信息，简要说明等，必要时应有更详尽的说明（将以此部分以空行隔开单独注释）。②内容：为文件源代码部分基本上按预处理语句、类型定义、变量定义、函数原型、函数实现（仅对.cpp文件）的顺序。main、winmain，控件注册等函数应放在内容部分的最后，类的定义按private、protected、pubilic、__pubished的顺序，并尽量保持每一部分只有一个，各部分中按数据、函数、属性、事件的顺序。③附加说明：文件末尾的补充说明，如参考资料等，若内容不多也可放在标题部分的最后。

4.3编辑风格

4.3.1缩进

缩进以4个空格为单位。建议在Tools/EditorOptions中设置General页面的Blockident为4，TabStop为4，不要选中Usetabcharacter。预处理语句、全局数据、函数原型、标题、附加说明、函数说明、标号等均顶格书写。语句块的“{”“}”配对对齐，并与其前一行对齐，语句块类的语句缩进建议每个“{”“}”单独占一行。

4.3.2空格

变量、类、常量数据和函数在其类型，修饰（如__fastcall等）名称之间适当空格并据情况对齐。关键字原则上空一格，如：if(...)等，运算符的空格规定如下：“::”、“-”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”（指正负号），“”（取址或引用）、“*”（指使用指针时）等几个运算符两边不加空格（其中单目运算符系指与操作数相连的一边），其它运算符（包括大多数二目运算符和三目运算符“?:”两边均加一空格，“(”、“)”运算符在其内侧空一格，在作函数定义时还可据情况多空或不空格来对齐，但在函数实现时可以不用。“,”运算符只在其后空一格，需对齐时也可不空或多空格，“sizeof”运算符建议也在其后空一格，不论是否有括号，对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。

4.3.3对齐

原则上关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多，必要时适当换行，换行时尽可能在“,”处或运算符处，换行后最好以运算符打头，并且以下各行均以该语句首行缩进，但该语句仍以首行的缩进为准，即如其下一行为“{”应与首行对齐。变量定义最好通过添加空格形成对齐，同一类型的变量最好放在一起。如下所示：

int????Value;

int????Result;

int????Length;

DWORD???Size;

DWORD???BufSize;

char*???pBuf;

void*???pOutputBuf;

LPCSTR*??pPath;

4.3.4空行

程序文件结构各部分之间空两行，若不必要也可只空一行，各