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

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

2、準，其其主要目目的在于于統(tǒng)一程程序設計計的記述述風格，培培養(yǎng)良好好的編碼碼習慣，使使代碼記記述清晰晰、明確確，具有有良好的的可讀性性。良好好的編碼碼習慣可可以幫助助程序員員避開不不必要的的語法或或語義錯錯誤，對對出現(xiàn)的的錯誤迅迅速定位位。另外外，良好好的編碼碼習慣還還有助于于在編碼碼過程中中對程序序的設計計思路進進行驗證證和提示示。本規(guī)范作為為編碼的的通常標標準，希希望每個個人都可可以通過過按此規(guī)規(guī)范進行行編碼，提提高程序序的可讀讀性、可可修改性性及維護護的效率率。如果果程序由由用戶指指定記述述標準或或使用（半半）自動動生成工工具時，可可適當遵遵循其標標準。2.編碼的的注意事事項(1)認真真分

3、析理理解系統(tǒng)統(tǒng)設計書書、程序序設計書書（有時時也包括括流程圖圖）。在在很好地地理解上上述文件件的基礎(chǔ)礎(chǔ)上編碼碼 （特別別是在程程序設計計書與編編碼的擔擔當者不不同時）。對對于不明明確之處處不可隨隨意判斷斷，應確確認后再再進行。(2)要注注意把編編制容易易理解（易易讀）的的程序放放到第一一位。在在頭腦中中要經(jīng)常?？紤]程程序的讀讀者，按按照向讀讀者說明明的方式式來寫是是一個竅竅門。讀讀起來容容易理解解的程序序一般質(zhì)質(zhì)量都比比較好、修修改維護護也容易易。(3)在編編碼的過過程中發(fā)發(fā)現(xiàn)了設設計上的的問題時時，要向向上追溯溯到系統(tǒng)統(tǒng)設計書書程序序設計書書。不可可輕易地地判斷，而而應經(jīng)設設計者確確認。(4

4、)關(guān)于于數(shù)據(jù)庫庫的記錄錄規(guī)范等等的包含含文件、模模塊頭、宏宏等，要要采用系系統(tǒng)統(tǒng)一一的規(guī)定定。個人人不可隨隨意地制制作。否否則就會會為以后后修改、改改造造成成困難。(5)在編編碼結(jié)束束后，要要對編碼碼重查。不不可未經(jīng)經(jīng)充分的的重查而而隨便進進入下一一步測試試階段。編編碼重查查作為最最簡便的的故障檢檢查手段段，也是是非常有有效的手手段，有有時可以以檢查出出在試驗驗工程中中不能全全部檢查查出的復復雜的錯錯誤。3.編碼風風格編碼的目標標首先是是清晰正正確，其其次才是是程序的的效率。以以下是在在編程時時應遵守守規(guī)則。(1)合理理使用ggotoo語句。合合理使用用gotto語句句可以提提高代碼碼的運行行

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

6、高高程序的的可讀性性，但過過多的注注釋不但但不能提提高程序序的可讀讀性，還還會降低低效率，因因此注釋釋一定要要適當。注注釋分為為序言性性注釋和和功能性性注釋兩兩種。在在文件頭頭、模塊塊頭、函函數(shù)和過過程的頭頭部的注注釋屬于于序言性性注釋。包包括以下下幾部分分內(nèi)容：功能描述。對對所執(zhí)行行的功能能進行簡簡略的介介紹。接口描述。簡簡述各輸輸入?yún)?shù)數(shù)和返回回值。數(shù)據(jù)描述。簡簡述用到到的重要要變量、結(jié)結(jié)構(gòu)和文文件等。履歷描述。包包括設計計者、日日期和版版本，文文件頭還還包括版版權(quán)聲名名。功能性注釋釋嵌在源源程序內(nèi)內(nèi)部用來來描述處處理功能能。(6)輸入入數(shù)據(jù)的的檢查。所所有輸入入數(shù)據(jù)都都應經(jīng)過過檢查。(7

7、)變量量使用前前要賦初初值。(8)錯誤誤處理。一一定要對對可能出出現(xiàn)的錯錯誤進行行處理，以以避免故故障引起起停機。4.序言性性注釋格格式（頭頭注釋）頭注釋可以以大致分分為文件件注釋、模模塊注釋釋、數(shù)據(jù)據(jù)注釋等等。在寫寫注釋時時推薦使使用以下下格式。文件注釋（文文件頭）,文件注注釋記述述以下信信息 (a)文文件識別別信息系統(tǒng)名（主主模塊時時）程序名或模模塊名版本信息（包包括時間間）所屬（從屬屬模塊時時）擔當著作權(quán)聲明明(b)文件件說明信信息簡介功能說明（主主要模塊塊說明）操作環(huán)境HH/W，PLAATFOORM，OS，MEMMORYY等編譯、連接接信息mmakee fiile名名，命令令過程文文件

8、名，編編譯、連連接選項項（Opptioon），應應連接的的裝配模模塊文件件名，子子程序庫庫名等文件維護信信息版本，日期期，作者者所屬部部門名，作作者姓名名，補充充說明等等創(chuàng)建信息更改記錄(d)其它它系統(tǒng)使用說說明（主主模塊時時）注意事項文件管理工工具的附附加信息息需要特別說說明的信信息SYSTEEMPROGRRAM/MODDULEEVERSIIONMASTEER MMODUULEAUTHOORCOPYRRIGHHTABSTRRACTT/PUURPOOSEFUNCTTIONNENVIRRONMMENTTMAKE OPTTIONNCREATTEUPDATTEUSAGEENOTESPECIIAL I

9、NFFO說明：“”表示標標準項目目，“”表示可可選項目目。模塊注釋（模模塊頭）。模模塊注釋釋對了解解模塊的的概要非非常有效效，而且且在維護護時也同同樣有效效，所以以一定要要記述。模模塊注釋釋記述以以下信息息模塊名模塊編號版本信息簡介功能說明影響注意事項返回值參數(shù)說明擔當創(chuàng)建信息更改記錄MODULLEIDVERSIIONABSTRRACTTFUNCTTIONNSIDE-EFFFECTTNOTERETURRNARGUMMENTTAUTHOORCREATTEUPDATTE說明：“”表示標標準項目目，“”表示可可選項目目。數(shù)據(jù)注釋數(shù)據(jù)注釋用用來幫助助對數(shù)據(jù)據(jù)結(jié)構(gòu)或或數(shù)據(jù)表表、數(shù)組組等內(nèi)容容的理解解。標

10、識符名（用用于標識識符定義義）數(shù)據(jù)結(jié)構(gòu)名名稱數(shù)據(jù)類型簡介注意事項TAGDATADATA-TYPPEABSTRRACTTNOTE說明：“”表示標標準項目目，“”表示可可選項目目。附錄: 頭頭注釋樣樣例以下為C語語言源文文件的注注釋樣例例主模塊文件件頭（程程序的主主模塊，生生成命令令程序。）/*/*/* 系統(tǒng)統(tǒng)： 系統(tǒng)名名 */* 用戶戶： 用戶名名 */* 程序序： 程序名名 - 標題 */* 擔當當部門： XXXXX*/* YYYYY*/* (CC)Coopyrrighht SShennyanng NNETSS innteggrattionn Coorpoorattionn 19996*/*

11、Alll RRighhts Resservved. */*/* VEERSIION DAATE BBY CHAANGEE/COOMMEENT*/* VVX.000 YYY-MMM/DDD 姓名 Creeatee*/* VVX.XXX YYY-MMM/DDD 姓名 更改 概要、更更改理由由*/*/* 功能能概略：功能概概略 */* 異異常處理理：異常常處理 */* 調(diào)調(diào)用方法法： */* 程序名名 Argg1 Argg2 */* 參參數(shù)說明明： */* II/0 參數(shù)數(shù)名 內(nèi)內(nèi)容 */* I Argg1 內(nèi)容容說明 */* I Argg2 內(nèi)容容說明 */* 適適用計算算機：計計算機類類型、型型

12、號 */* OOS： OOS名稱稱（版本本） */* 大大?。?內(nèi)存 MMB */* 交換 MMB */* 編編譯： 編譯系系統(tǒng)名稱稱（版本本） */* 連連接信息息： 連接接信息 */*/*/* 請請注意：未經(jīng)許許可，不不可擅自自使用、轉(zhuǎn)轉(zhuǎn)載本內(nèi)內(nèi)容的一一部分或或全部。*/*/*/模塊文件頭頭（從屬屬模塊）/*/*/* 系統(tǒng)統(tǒng)： 系系統(tǒng)名 */* 用戶戶： 用用戶名 */* 模塊塊： 模模塊名- 標題題 */* 所屬屬： 主主模塊名名或程序序名 */* 擔當當部門： XXXXXX */* YYYYY */* (CC)Coopyrrighht SShennyanng NNETSS Innteg

13、grattionn Coorpoorattionn 19996 */* AAll Rigghtss Reeserrvedd. */*/* VVERSSIONN DDATEE BY CHAANGEE/COOMMEENT */* VX.00 YY-MM/DD 姓名名 Creeatee */* VX.XX YY-MM/DD 姓名名 更改概概要、更更改理由由 */*/* 功功能概略略：功能能概略 */* 異常處處理：異異常處理理 */* 調(diào)用順順序： */* iint I11 */* : */* ccharr 011 */* ssts = (&I11,.,&011); */* 參數(shù)說說明： */* I

14、/0 變量名名 內(nèi)容容 */* II II1 內(nèi)容容說明 */* : */* II 001 內(nèi)容容說明 */* 00 SSTS 內(nèi)容容說明 */* 適適用計算算機：計計算機類類型、型型號 */* OOS： OOS名稱稱（版本本） */* 編編譯： 編編譯系統(tǒng)統(tǒng)（版本本） */* 連連接信息息： 連接信信息 */*/* 請注注意：未未經(jīng)許可可，不可可擅自使使用、轉(zhuǎn)轉(zhuǎn)載本內(nèi)內(nèi)容的一一部分或或全部。*/*/文件頭例/* * Coppyriightt 119944-19995 Miicroosofft CCorpporaatioon. Alll RRighhts Resservved. *PROOGR

15、AAM:winnproog.cc * *PURRPOSSE:Winndowws pproggramm. * *PLAATFOORMSS:Winndowws 995 * *FUNNCTIIONSS: *WinnMaiin() - callls iniitiaalizzatiion funnctiion, prroceessees mmesssagee looop *IniitApppliicattionn() - IInittiallizees wwinddow datta nnd rregiisteers winndoww *IniitInnstaancee() -saavess innsta

16、ancee haandlle aand creeatees mmainn wiindoow *MaiinWiindPProcc() Proocesssess meessaagess *Aboout() - Prroceess mennssaagess foor Aboout diialoog bbox */模塊頭1/* * MODDULEE: mmainn *VERRSIOON: 11.1 *ABSSTRAACT: mmainn fuuncttionn off prrogrram *FUNNCTIION: ffuncctioon oof mmainn *ARGGUMEENT: * arrgcc

17、ouunt of commmannd llinee arrgummentt * arrgvcommmannd llinee arrgummentt *RETTURNN: * 0norrmall ennd * 1abnnormmal endd *SIDDE-EEFFEECT: *NOTTE: *CREEATEE: 996-007Netts1 *UPDDATEE: 996-008Netts2 * tthe reaasonn *UPDDATEE: 996-009Netts3 */模塊頭2/*/* */* 模模塊： 模塊塊名 - 標題題 */* 功功能概略略： 功能概概略 */* */*/類型聲明/* * TAGG: DDemooStrructt *ABSSTRAACT: DDemoo