系統(tǒng)集成公司編碼標準概述

1、19/24編碼標準 批準人劉巖審核人崔戈擬制人劉慧豐批準日期1999512生效日期1999512關聯(lián)文件沈陽東東系統(tǒng)集成有限公司更改記錄序號發(fā)行日更改對象更改內(nèi)容批準審查擬制01999512新發(fā)行劉巖崔戈劉慧豐目 錄1.目的2/42.編碼的注意事項2/43.編碼風格 2/44.序言性注釋格式3/4附錄頭注釋樣例1/4(附)1.目的編碼是以程序設計時做成的程序規(guī)范書、流程等邏輯設計書為基礎。在編碼時，為減少在編碼水平上的個人差異、順利地進入單體試驗時期,以及便于進行調(diào)試和提高維護效率，特制定本標準。本標準作為代碼的書寫標準，其要緊目的在于統(tǒng)一程序設計的記述風格，培養(yǎng)良好的編碼適應，使代碼記述清晰

2、、明確，具有良好的可讀性。良好的編碼適應能夠關心程序員避開不必要的語法或語義錯誤，對出現(xiàn)的錯誤迅速定位。另外，良好的編碼適應還有助于在編碼過程中對程序的設計思路進行驗證和提示。本規(guī)范作為編碼的通常標準，希望每個人都能夠通過按此規(guī)范進行編碼，提高程序的可讀性、可修改性及維護的效率。假如程序由用戶指定記述標準或使用（半）自動生成工具時，可適當遵循其標準。2.編碼的注意事項(1)認真分析理解系統(tǒng)設計書、程序設計書（有時也包括流程圖）。在專門好地理解上述文件的基礎上編碼 （特不是在程序設計書與編碼的擔當者不同時）。關于不明確之處不可隨意推斷，應確認后再進行。(2)要注意把編制容易理解（易讀）的程序放到

3、第一位。在頭腦中要經(jīng)?？紤]程序的讀者，按照向讀者講明的方式來寫是一個竅門。讀起來容易理解的程序一般質(zhì)量都比較好、修改維護也容易。(3)在編碼的過程中發(fā)覺了設計上的問題時，要向上追溯到系統(tǒng)設計書程序設計書。不可輕易地推斷，而應經(jīng)設計者確認。(4)關于數(shù)據(jù)庫的記錄規(guī)范等的包含文件、模塊頭、宏等，要采納系統(tǒng)統(tǒng)一的規(guī)定。個人不可隨意地制作。否則就會為以后修改、改造造成困難。(5)在編碼結(jié)束后，要對編碼重查。不可未經(jīng)充分的重查而隨便進入下一步測試時期。編碼重查作為最簡便的故障檢查手段，也是特不有效的手段，有時能夠檢查出在試驗工程中不能全部檢查出的復雜的錯誤。3.編碼風格編碼的目標首先是清晰正確，其次才是

4、程序的效率。以下是在編程時應遵守規(guī)則。(1)合理使用goto語句。合理使用goto語句能夠提高代碼的運行效率，但goto語句的使用會破壞程序的結(jié)構(gòu)特性，因此要限制使用的范圍。(2)用括號體現(xiàn)優(yōu)先級和嵌套的層次。用括號體現(xiàn)優(yōu)先級和嵌套的層次可使程序更清晰，同時能夠有效地幸免二義性。(3)利用標準書寫格式提高程序的可讀性。用分層縮進顯示嵌套結(jié)構(gòu)的層次。每行只寫一條語句。在注釋段的周圍加邊框。在注釋段與程序段以及不同程序段之間插入空行。(4)命名規(guī)則。命名應有實際意義，一般格式為：前綴+由形容詞、名詞或動詞組成的詞組。前綴由使用的語言決定。(5)適當?shù)淖⑨?。適當?shù)淖⑨屇芴岣叱绦虻目勺x性，但過多的注釋

5、不但不能提高程序的可讀性，還會降低效率，因此注釋一定要適當。注釋分為序言性注釋和功能性注釋兩種。在文件頭、模塊頭、函數(shù)和過程的頭部的注釋屬于序言性注釋。包括以下幾部分內(nèi)容：功能描述。對所執(zhí)行的功能進行簡略的介紹。接口描述。簡述各輸入?yún)?shù)和返回值。數(shù)據(jù)描述。簡述用到的重要變量、結(jié)構(gòu)和文件等。履歷描述。包括設計者、日期和版本，文件頭還包括版權(quán)聲名。功能性注釋嵌在源程序內(nèi)部用來描述處理功能。(6)輸入數(shù)據(jù)的檢查。所有輸入數(shù)據(jù)都應通過檢查。(7)變量使用前要賦初值。(8)錯誤處理。一定要對可能出現(xiàn)的錯誤進行處理，以幸免故障引起停機。4.序言性注釋格式（頭注釋）頭注釋能夠大致分為文件注釋、模塊注釋、數(shù)據(jù)

6、注釋等。在寫注釋時推舉使用以下格式。文件注釋（文件頭）,文件注釋記述以下信息 (a)文件識不信息系統(tǒng)名（主模塊時）程序名或模塊名版本信息（包括時刻）所屬（從屬模塊時）擔當著作權(quán)聲明(b)文件講明信息簡介功能講明（要緊模塊講明）操作環(huán)境H/W，PLATFORM，OS，MEMORY等編譯、連接信息make file名，命令過程文件名，編譯、連接選項（Option），應連接的裝配模塊文件名，子程序庫名等文件維護信息版本，日期，作者所屬部門名，作者姓名，補充講明等創(chuàng)建信息更改記錄(d)其它系統(tǒng)使用講明（主模塊時）注意事項文件治理工具的附加信息需要特不講明的信息SYSTEMPROGRAM/MODULEV

7、ERSIONMASTER MODULEAUTHORCOPYRIGHTABSTRACT/PURPOSEFUNCTIONENVIRONMENTMAKE OPTIONCREATEUPDATEUSAGENOTESPECIAL INFO講明：“”表示標準項目，“”表示可選項目。模塊注釋（模塊頭）。模塊注釋對了解模塊的概要特不有效，而且在維護時也同樣有效，因此一定要記述。模塊注釋記述以下信息模塊名模塊編號版本信息簡介功能講明阻礙注意事項返回值參數(shù)講明擔當創(chuàng)建信息更改記錄MODULEIDVERSIONABSTRACTFUNCTIONSIDE-EFFECTNOTERETURNARGUMENTAUTHORCRE

8、ATEUPDATE講明：“”表示標準項目，“”表示可選項目。數(shù)據(jù)注釋數(shù)據(jù)注釋用來關心對數(shù)據(jù)結(jié)構(gòu)或數(shù)據(jù)表、數(shù)組等內(nèi)容的理解。標識符名（用于標識符定義）數(shù)據(jù)結(jié)構(gòu)名稱數(shù)據(jù)類型簡介注意事項TAGDATADATA-TYPEABSTRACTNOTE講明：“”表示標準項目，“”表示可選項目。附錄: 頭注釋樣例以下為C語言源文件的注釋樣例主模塊文件頭（程序的主模塊，生成命令程序。）/*/*/* 系統(tǒng)： 系統(tǒng)名 */* 用戶： 用戶名 */* 程序： 程序名 - 標題 */* 擔當部門： XXXX*/* YYYY*/* (C)Copyright Shenyang NETS integration Corpora

9、tion 1996*/* All Rights Reserved. */*/* VERSION DATE BY CHANGE/COMMENT*/* VX.00 YY-MM/DD 姓名 Create*/* VX.XX YY-MM/DD 姓名 更改 概要、更改理由*/*/* 功能概略：功能概略 */* 異常處理：異常處理 */* 調(diào)用方法： */* 程序名 Arg1 Arg2 */* 參數(shù)講明： */* I/0 參數(shù)名 內(nèi)容 */* I Arg1 內(nèi)容講明 */* I Arg2 內(nèi)容講明 */* 適用計算機：計算機類型、型號 */* OS： OS名稱（版本） */* 大?。?內(nèi)存 MB */* 交

10、換 MB */* 編譯： 編譯系統(tǒng)名稱（版本） */* 連接信息： 連接信息 */*/*/* 請注意：未經(jīng)許可，不可擅自使用、轉(zhuǎn)載本內(nèi)容的一部分或全部。*/*/*/模塊文件頭（從屬模塊）/*/*/* 系統(tǒng)： 系統(tǒng)名 */* 用戶： 用戶名 */* 模塊： 模塊名- 標題 */* 所屬： 主模塊名或程序名 */* 擔當部門： XXXX */* YYYY */* (C)Copyright Shenyang NETS Integration Corporation 1996 */* All Rights Reserved. */*/* VERSION DATE BY CHANGE/COMMENT *

11、/* VX.00 YY-MM/DD 姓名 Create */* VX.XX YY-MM/DD 姓名 更改概要、更改理由 */*/* 功能概略：功能概略 */* 異常處理：異常處理 */* 調(diào)用順序： */* int I1 */* : */* char 01 */* sts = (&I1,&01); */* 參數(shù)講明： */* I/0 變量名 內(nèi)容 */* I I1 內(nèi)容講明 */* : */* I 01 內(nèi)容講明 */* 0 STS 內(nèi)容講明 */* 適用計算機：計算機類型、型號 */* OS： OS名稱（版本） */* 編譯： 編譯系統(tǒng)（版本） */* 連接信息： 連接信息 */*/* 請注

12、意：未經(jīng)許可，不可擅自使用、轉(zhuǎn)載本內(nèi)容的一部分或全部。*/*/文件頭例/* * Copyright 1994-1995 Microsoft Corporation. All Rights Reserved. *PROGRAM:winprog.c * *PURPOSE:Windows program. * *PLATFORMS:Windows 95 * *FUNCTIONS: *WinMain() - calls initialization function, processes message loop *InitApplication() - Initializes window data

13、 nd registers window *InitInstance() -saves instance handle and creates main window *MainWindProc() Processes messages *About() - Process menssages for About dialog box */模塊頭1/* * MODULE: main *VERSION: 1.1 *ABSTRACT: main function of program *FUNCTION: function of main *ARGUMENT: * argccount of command line argument * argvcommand line argument *RETURN: * 0normal end * 1abnormal end *SIDE-EFFECT: *NOTE: *CREATE: 96-07Nets1 *UPDATE: 96-08Nets2 * the reason *UPDATE: 96-09Nets3 */模塊頭2/*/* */* 模塊： 模塊名 - 標題 */* 功能概略： 功能概略 */* */*/類型聲明/* * TAG: DemoStruct *ABSTRACT: D