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

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

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

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

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