1、編碼標準批準人劉巖審核人崔戈擬制人劉慧豐批準日期1999.5. 12生效日期19995. 12關聯文件沈陽東東系統集成有限公司更改記錄序號發行日更改對象更改內容批準審查擬制01999. 5. 12新發行劉巖崔戈劉慧豐目 錄1 .目的2/42 .編碼的注意事項2/43 .編碼風格2/44 .序言性注釋格式3/4附錄頭注釋樣例1/4（附）L目的編碼是以程序設計時做成的程序規范書、流程等邏輯設計書為基礎。在編碼時，為減少在編碼水平上的 個人差異、順利地進入單體試驗階段，以及便于進行調試和提高維護效率，特制定本標準。本標準作為代碼的書寫標準，其主要目的在于統一程序設計的記述風格，培養良好的編碼習慣，使

2、代碼 記述清晰、明確，具有良好的可讀性。良好的編碼習慣可以幫助程序員避開不必要的語法或語義錯誤，對出 現的錯誤迅速定位。另外，良好的幽迺睜助于在編碼過程中對程序的設計思路進行驗證和提示。本規范作為編碼的通常標準，|希望每個人|都可以通過按此規范進行編碼,提高程序的可讀性、可修改性 及維護的效率°如果程序由用戶指定記述標準或使用(半)自動生成工具時，可適當遵循其標準。2 .編碼的注意事項(1)認真分析理解系統設計書、程序設計書(有時也包括流程圖)。在很好地理解上述文件的基礎上編碼 (特別是在程序設計書與編碼的擔當者不同時)。對于不明確之處不可隨意判斷，應確認后再進行°(2)要

3、注意把編制容易理解(易讀)的程序放到第一位。在頭腦中要經常考慮程序的讀者，按照向讀者說 明的方式來寫是一個竅門。讀起來容易理解的程序一般質量都比較好、修改維護也容易，(3)在編碼的過程中發現了設計上的問題時，要向上追溯到系統設計書/程序設計書。不可輕易地判斷, 而應經設計者確認。(4)關于數據庫的記錄規范等的包含文件、模塊頭、宏等，要采用系統統一的規定。個人不可隨意地制作。 否則就會為以后修改、改造造成困難。(5)在編碼結束:后，要對編碼重查。不可未經充分的重查而隨便進入下一步測試階段,編碼重查作為最簡 便的故障檢查手段，也是非常有效的手段，有時可以檢查出在試驗工程中不能全部檢查出的復雜的錯誤

4、。3.編碼風格編碼的目標首先是清晰正確，其次才是程序的效率。以下是在編程時應遵守規則。(1)合理使用goto語句。合理使用got。語句可以提高代碼的運行效率，但goto語句的使 用會破壞程序的結構特性，因此要限制使用的范圍。(2)用括號體現優先級和嵌套的層次。用括號體現優先級和嵌套的層次可使程序更清晰，并 且能夠有效地避免二義性。(3)利用標準書寫格式提高程序的可讀性。a.用分層縮進顯示嵌套結構的層次。b.每行只寫一條語句。c.在注釋段的周圍加邊框。d.在注釋段與程序段以及不同程序段之間插入空行。(4)命名規則。命名應有實際意義，一般格式為：前綴+由形容詞、名詞或動詞組成的詞組。 前綴由使用的

5、語言決定。a.功能描述。b.接口描述。C.數據描述。d.履歷描述。(5)適當的注釋。適當的注釋能提高程序的可讀性，但過多的注釋不但不能提高程序的可讀 性，還會降低效率，因此注釋一定要適當。注釋分為序言性注釋和功能性注釋兩種。在文件頭、 模塊頭、函數和過程的頭部的注釋屬于序言性注釋。包括以下兒部分內容： 對所執行的功能進行簡略的介紹。簡述各輸入參數和返回值。簡述用到的重要變量、結構和文件等。包括設計者、日期和版本，文件頭還包括版權聲名。功能性注釋嵌在源程序內部用來描述處理功能。(6)輸入數據的檢查。所有輸入數據都應經過檢查。(7)變量使用前要賦初值。(8)錯誤處理。一定要對可能出現的錯誤進行處理

6、，以避免故障引起停機。4.序言性注釋格式（頭注釋）頭注釋可以大致分為文件注釋、模塊注釋、數據注釋等。（1）文件注釋（文件頭），文件注釋記述以下信息文件識別信息* 系統名（主模塊時）* 程序名或模塊名* 版本信息（包括時間）* 所屬（從屬模塊時）* 擔當* 著作權聲明（b）文件說明信息* 簡介* 功能說明（主要模塊說明）* 操作環境H/W, PLATFORM, OS, MEMORY 等* 編譯、連接信息make file名，命令過程文件名，編譯、連接選 項（Option）,應連接的裝配模塊文件名，子程 序庫名等（C）文件維護信息版本，日期，作者所屬部門名，作者姓名，補充說在寫注釋時推薦使用以下格

7、式。* SYSTEM* PROGRAMAdODULE* VERSION柒 MASTER MODULE* AUTHOR* COPYRIGHT* ABSTRACT/PURPOSE* FUNCTION* ENVIRONMENT* MAKE OPTION*柒法*明等* 創建信息* 更改記錄（d）其它* 系統使用說明（主模塊時）* 注意事項* 文件管理工具的附加信息 需要特別說明的信息說明：“事”表示標準項目，“柒”表示可選項目。（2）模塊注釋（模塊頭），模塊注釋對了解模塊的概要非常有效, 要記述。模塊注釋記述以下信息* 模塊名* 模塊編號* 版本信息* 簡介* 功能說明* 影響* 注意事項* 返回值*

8、 參數說明* 擔當* 創建信息柒更改記錄CREATE UPDATEUSAGENOTESPECIAL INFO而且在維護時也同樣有效，所以一定MODULEIDVERSIONABSTRACTFUNCTIONSIDE-EFFECTNOTERETURNARGUMENTAUTHORCREATEUPDATE說明：“事”表示標準項目，“米”表示可選項目。（3）數據注釋數據注釋用來幫助對數據結構或數據表、數組等內容的理解C* 標識符名（用于標識符定義）* 數據結構名稱* 數據類型* 簡介興注意事項TAG DATA DATA-TYPE ABSTRACT NOTE說明：“事”表示標準項目，“米”表示可選項目。編號

9、：時間：2021年X月X日書山有路勤為徑，學海無涯苦作舟 頁碼：第5頁共11頁第10頁共11頁附錄：頭注釋樣例以下為c語言源文件的注釋樣例*/*/1 .主模塊文件頭（程序的主模塊,生成命令程序。）/*/*系統：系統名*/*用戶：用戶名*/*程序：程序名-標題*/*擔當部門：XXXX*/*YYYY*/* (C)Copyright Shenyang NETS integration Corporation 1996All Rights Reserved./*/*/*VERSION DATEVX.00 YY-MM/DDBYCHANGE/COMMENT姓名 Create*/*/*VX.XX YY-MM

10、/DD姓名更改概要、更改理由*/*/*功能概略：功能概略*/*異常處理：異常處理*/*調用方法：*/*程序名Argl Arg2*/*參數說明：*/*I/O參數名內容*/*IArgl內容說明*/*IAra2內容說明*/*適用計算機：計算機類型、型號*/*OS：OS名稱（版本）*/*大小：內存MB*/*交換MB*/*編譯：編譯系統名稱（版本）*/*連接信息：連接信息*/*/*/*請注意：未經許可，不可擅自使用、轉載本內容的一部分或全部。*/*/*/2 .模塊文件頭(從屬模塊)CHANGE/COMMENTCreate更改概要、更改理由*/*/*/*/*/*系統：系統名*/*用戶：用戶名*/*模塊：模

11、塊名-標題*/*所屬：主模塊名或程序名*/*擔當部門:XXXX*/*YYYY*/* (C)Copyright Shenyang NETS Integration Corporation 1996*/*All Rights Reserved.*/* VERSION DATE BY/*VX.00 YY-MM/DD 姓名/* VX.XX YY-MM/DD 姓名/*/*功能概略：功能概略 */*異常處理：異常處理 */*調用順序：*/*int11*/*/*char01*/*sts = (&IL.,&01);*/*參數說明：*/*I/O變量名內容*/*III內容說明*/*/*I01內容說

12、明*/*0STS內容說明*/*適用計算機:計算機類型、型號*/*OS：OS名稱（版本）*/*編譯：編譯系統（版本）*/*連接信息：連接信息*/*/*請注意：未經許可，不可擅自使用、轉載本內容的一部分或全部。*/*/3 .文件頭例 /* Copyright 1994-1995 Microsoft Corporation. All Rights Reserved.* PROGRAM:winprog.c* PURPOSE:Windowsprogram.* PLATFORMS:Windows 9512 FUNCTIONS:WinMain() - calls initialization functio

13、n, processes message loop3 InitApplicationO - Initializes window data nd registers window4 InitlnstanceO -saves instance handle and creates main window5 MainWindProcO Processes messages6 About() - Process menssages for “About” dialog box */4 .模塊頭1/*MODULE:main*VERSION:1.1*ABSTRACT:main function of programFUNCTION:function of main*ARGUMENT .*argc count of command line argument*argv command line argument*RETURN*0 normal end*1 abnormal end*SIDE-EFFECT*NOTE *CREATE:96-07 Netsl*UPDATE:96-08 Nets2the reason*UPDATE:96-09 Nets3*/5 .模塊頭2/*/*/*模塊： 模塊名-標題*/*功能概略：功能概略*/*/*/6 .類型聲明/*TAG:DemoStr