軟件質(zhì)量 QG-21-01軟件開(kāi)發(fā)編程指南

1、.質(zhì)量管理運(yùn)作體系文件三級(jí)文件 1 引言1.1 編寫(xiě)目的闡明軟件開(kāi)發(fā)編程指南編寫(xiě)的目的，并指明讀者對(duì)象。如果軟件開(kāi)發(fā)編程指南在實(shí)施過(guò)程中可能需要修改，應(yīng)在此說(shuō)明。1.2 項(xiàng)目背景應(yīng)包括項(xiàng)目來(lái)源、主管部門(mén)及軟件概述。1.3 定義列出文檔中所使用的專(zhuān)門(mén)術(shù)語(yǔ)的定義和縮寫(xiě)詞的原義。1.4 參考資料列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，可包括：需求規(guī)格說(shuō)明書(shū)、概要設(shè)計(jì)說(shuō)明書(shū)、用戶手冊(cè)、測(cè)試計(jì)劃、本文檔中引用的其他資料。以下章節(jié)按軟件開(kāi)發(fā)編程中涉及到的方面，每個(gè)方面為一個(gè)單獨(dú)的章節(jié)，作一單獨(dú)的闡述。涉及到的方面包括：功能測(cè)試、集成測(cè)試、強(qiáng)度測(cè)試、確認(rèn)測(cè)試等。1.5 命名規(guī)則1.5.

2、1 常量命名列出常量命名中，前綴的規(guī)則，大小寫(xiě)的規(guī)則，常量長(zhǎng)度的定義等。 宏定義命名 根據(jù)使用的語(yǔ)言，定義宏定義的大小寫(xiě)規(guī)則，書(shū)寫(xiě)的定義1.5.2 變量命名基本規(guī)則定義變量命名的規(guī)則，比如：舉C語(yǔ)言的例子：程序中所有變量的命名遵循以下的組成規(guī)則：<作用域名>+<類(lèi)型前綴名>+<自定義名>其中作用域名區(qū)分函數(shù)內(nèi)局部變量、模塊內(nèi)全局變量和全局變量；類(lèi)型前綴名是單個(gè)或幾個(gè)不同基本數(shù)據(jù)類(lèi)型的組合；變量的自定義名字由英文字母和數(shù)字組成，使用大小寫(xiě)字母區(qū)分各單詞，首字符為大寫(xiě)英文字母。整個(gè)變量名的總長(zhǎng)度不設(shè)限制（只要符合C編譯器的規(guī)定就行）。1.5.3 作用域名變量的作

3、用域名主要分函數(shù)內(nèi)有效的局部變量、模塊內(nèi)有效的全局變量和全局變量（在整個(gè)應(yīng)用范圍內(nèi)有效的變量），以及對(duì)于這些變量的命名規(guī)則1.5.4 函數(shù)命名定義函數(shù)的命名規(guī)則如：函數(shù)名的組成為<模塊名>+<自定義功能名>，所有的公共庫(kù)函數(shù)必須都有模塊名，比如TCP/IP通訊類(lèi)的公共庫(kù)函數(shù)，此類(lèi)函數(shù)應(yīng)有模塊名如為tcp，則所有對(duì)外開(kāi)放的庫(kù)函數(shù)調(diào)用都應(yīng)以tcp開(kāi)頭，例如tcpConnect()可以是TCP/IP類(lèi)公共庫(kù)函數(shù)的一個(gè)調(diào)用名。所有非公共庫(kù)函數(shù)名的定義中，模塊名可以被省略。自定義功能名的命名方法與變量命名中的自定義名一致。1.5.5 文件命名文件命名指源程序文件、嵌入式源程序文件

4、、頭文件、數(shù)據(jù)文件、配置文件、日志文件、命令文件、SQL命令文件、幫助文件、二進(jìn)制可執(zhí)行文件等的命名規(guī)則。1.5.6 目錄樹(shù)結(jié)構(gòu)及命名對(duì)于軟件開(kāi)發(fā)中各級(jí)目錄樹(shù)的命名規(guī)則1.6 注釋使用規(guī)范1.6.1 共同性規(guī)則共同性規(guī)則指源程序和頭文件中通用注釋根據(jù)注釋在源程序中說(shuō)明對(duì)象的不同，注釋可以大致分為程序功能注釋、變量功能注釋、函數(shù)功能注釋、算法描述注釋和修改標(biāo)識(shí)注釋幾類(lèi)，在以下的幾個(gè)小節(jié)中將會(huì)具體描述各類(lèi)注釋的使用規(guī)范1.6.2 源程序功能說(shuō)明根據(jù)具體的語(yǔ)言，定義源程序的功能注釋規(guī)則1.6.3 變量功能說(shuō)明變量主要通過(guò)取用合適的名字來(lái)說(shuō)明變量的意義或功能，而不是靠使用注釋來(lái)說(shuō)明其用法，但有需要的話，可在此定義其注釋規(guī)則1.6.4 函數(shù)功能說(shuō)明函數(shù)功能說(shuō)明的規(guī)則1.6.5 過(guò)程算法描述過(guò)程算法描述的規(guī)則1.6.6 修改標(biāo)識(shí)說(shuō)明修改標(biāo)識(shí)主要是在程序中指明是在何時(shí)由何人修改了程序，配合過(guò)程算法描述可以說(shuō)明修改部分的前因后果。修改標(biāo)識(shí)的組成為：<Name Initial>+<Modification Date>1.7 數(shù)據(jù)說(shuō)明及定義規(guī)范數(shù)據(jù)說(shuō)明的規(guī)范。1.8 函數(shù)說(shuō)明及定義規(guī)范函數(shù)說(shuō)明的規(guī)范1.9 語(yǔ)言使用及書(shū)寫(xiě)規(guī)范本章中對(duì)語(yǔ)言中部分常用的語(yǔ)句給出使用的規(guī)則，同時(shí)也規(guī)定部分禁用的語(yǔ)句。1.10 嵌入式SQL語(yǔ)句使用及書(shū)寫(xiě)規(guī)范嵌入式S