某系統(tǒng)集成公司編碼標(biāo)準(zhǔn)概述

編碼標(biāo)準(zhǔn)創(chuàng)揮帝批準(zhǔn)人挑劉巖嗚審核人躺崔戈鴿擬制人穩(wěn)劉慧豐鐵批準(zhǔn)日期脆1999．遇5．12孫生效日期睜1999．驅(qū)5．12月關(guān)道聯(lián)他文谷件扎沈陽(yáng)東東系逐統(tǒng)集成有限汪公司更改記錄欄序號(hào)秋發(fā)行日篩更改對(duì)象塞·學(xué)更改內(nèi)容傅批準(zhǔn)訂審查鋪擬制晶0胃1999．榴5．12鋤新發(fā)行煮劉巖枝崔戈羊劉慧豐摟目森蒙錄杯1.塊黑目的看銜2/易4秤2.景蒼編碼的注意匠事項(xiàng)都冒2/腦4撫3.基督編碼風(fēng)格桑繁恭2券/距4喝4.某銳序言性注釋全格式掙脅3/懸4附錄和頭注釋樣例顯飯1裳/挖4廣(證附藝)1.目的絞編碼是以程叢序設(shè)計(jì)時(shí)做糠成的程序規(guī)劍范書、流程妻等邏輯設(shè)計(jì)諷書為基礎(chǔ)。沫在編碼時(shí)，堤為減少在編陳碼水平上的籍個(gè)人差異、熱順利地進(jìn)入需單體試驗(yàn)階呈段或,刪以及便于進(jìn)目行調(diào)試和提岔高維護(hù)效率流，特制定本葛標(biāo)準(zhǔn)。府本標(biāo)準(zhǔn)作為理代碼的書寫待標(biāo)準(zhǔn)，其主企要目的在于零統(tǒng)一程序設(shè)戰(zhàn)計(jì)的記述風(fēng)砌格，培養(yǎng)良督好的編碼習(xí)宗慣，使代碼雅記述清晰、淚明確，具有直良好的可讀喝性。良好的比編碼習(xí)慣可楊以幫助程序松員避開不必跪要的語(yǔ)法或葵語(yǔ)義錯(cuò)誤，托對(duì)出現(xiàn)的錯(cuò)這誤迅速定位革。另外，良普好的編碼習(xí)毀慣還有助于宗在編碼過程脊中對(duì)程序的反設(shè)計(jì)思路進(jìn)茄行驗(yàn)證和提酒示?？急疽?guī)范作為噴編碼的通常跌標(biāo)準(zhǔn)，稼希望每個(gè)人遙都可以通過挺按此規(guī)范進(jìn)訪行編碼，提塌高程序的可飛讀性、可修癢改性及維護(hù)水的效率。如艇果程序由用銅戶指定記述就標(biāo)準(zhǔn)或使用相（半）自動(dòng)食生成工具時(shí)播，可適當(dāng)遵焰循其標(biāo)準(zhǔn)。版2.洽編碼的注意毅事項(xiàng)治(1)徐認(rèn)真分析理氏解系統(tǒng)設(shè)計(jì)拘書、程序設(shè)筆計(jì)書（有時(shí)直也包括流程值圖）。在很駝好地理解上壽述文件的基截礎(chǔ)上編碼皆爭(zhēng)（特別是在賴程序設(shè)計(jì)書興與編碼的擔(dān)萄當(dāng)者不同時(shí)繡）。對(duì)于不奸明確之處不冬可隨意判斷門，應(yīng)確認(rèn)后狗再進(jìn)行。豐(嶼2兵)油要注意把編腐制容易理解挎（易讀）的元程序放到第吐一位。在頭洲腦中要經(jīng)常乏考慮程序的右讀者，按照誼向讀者說明鬼的方式來寫糖是一個(gè)竅門顛。讀起來容桌易理解的程娃序一般質(zhì)量青都比較好、功修改維護(hù)也爆容易。托(礦3厲)是在編碼的過羊程中發(fā)現(xiàn)了翁設(shè)計(jì)上的問猶題時(shí)，要向個(gè)上追溯到系瞧統(tǒng)設(shè)計(jì)書／蜜程序設(shè)計(jì)書屋。不可輕易柔地判斷，而朵應(yīng)經(jīng)設(shè)計(jì)者皺確認(rèn)?？?莊4泥)勸關(guān)于數(shù)據(jù)庫(kù)僑的記錄規(guī)范詳?shù)鹊陌奶m件、模塊頭那、宏等，要培采用系統(tǒng)統(tǒng)嶄一的規(guī)定。眼個(gè)人不可隨哨意地制作。扁否則就會(huì)為票以后修改、抱改造造成困迫難。束(對(duì)5拳)天在編碼結(jié)束訪后，要對(duì)編蹄碼重查。不晃可未經(jīng)充分鈔的重查而隨暖便進(jìn)入下一躍步測(cè)試階段僵。編碼重查特作為最簡(jiǎn)便敵的故障檢查款手段，也是脈非常有效的腔手段，有時(shí)蔥可以檢查出啊在試驗(yàn)工程濾中不能全部巧檢查出的復(fù)麥雜的錯(cuò)誤。潤(rùn)3.楚編碼風(fēng)格舞編碼的目標(biāo)素首先是清晰權(quán)正確，其次藥才是程序的籃效率。以下?lián)问窃诰幊虝r(shí)紗應(yīng)遵守規(guī)則拴?？?寸1獸)覆合理使用g腐oto語(yǔ)句遮。合理使用答goto語(yǔ)院句可以提高賣代碼的運(yùn)行率效率，但g旬oto語(yǔ)句泄的使用會(huì)破默壞程序的結(jié)嚴(yán)構(gòu)特性，因甩此要限制使曬用的范圍。湖(補(bǔ)2標(biāo))泥用括號(hào)體現(xiàn)奇優(yōu)先級(jí)和嵌偽套的層次。勸用括號(hào)體現(xiàn)斑優(yōu)先級(jí)和嵌升套的層次可妄使程序更清掙晰，并且能鬼夠有效地避啄免二義性。積(凱3教)父利用標(biāo)準(zhǔn)書高寫格式提高火程序的可讀隔性。迅用分層縮進(jìn)獨(dú)顯示嵌套結(jié)羞構(gòu)的層次。胡每行只寫一喘條語(yǔ)句。遲在注釋段的他周圍加邊框捧。妙在注釋段與虛程序段以及案不同程序段膜之間插入空張行。拴(敏4瓣)腦命名規(guī)則。未命名應(yīng)有實(shí)少際意義，一渴般格式為：簡(jiǎn)前綴+由形念容詞、名詞推或動(dòng)詞組成震的詞組。前肝綴由使用的而語(yǔ)言決定。宵(飄5饑)熱適當(dāng)?shù)淖⑨屍?。適當(dāng)?shù)淖⒃汜屇芴岣叱谈G序的可讀性深，但過多的寶注釋不但不禁能提高程序績(jī)的可讀性，屑還會(huì)降低效忠率，因此注臉釋一定要適旅當(dāng)。注釋分勁為序言性注異釋和功能性會(huì)注釋兩種。兔在文件頭、欣模塊頭、函忍數(shù)和過程的傻頭部的注釋詞屬于序言性緒注釋。包括啦以下幾部分勉內(nèi)容：莫功能描述。恭對(duì)所執(zhí)行的炮功能進(jìn)行簡(jiǎn)跑略的介紹。凡接口描述。央簡(jiǎn)述各輸入奸參數(shù)和返回罪值。仆數(shù)據(jù)描述。丈簡(jiǎn)述用到的舉重要變量、肢結(jié)構(gòu)和文件爺?shù)?。粉履歷描述。布包括設(shè)計(jì)者顏、日期和版慕本，文件頭勢(shì)還包括版權(quán)昌聲名。刪功能性注釋華嵌在源程序迷內(nèi)部用來描燙述處理功能長(zhǎng)。家(權(quán)6稀)故輸入數(shù)據(jù)的僻檢查。所有困輸入數(shù)據(jù)都?jí)螒?yīng)經(jīng)過檢查歡。程(嫂7勝)花變量使用前奮要賦初值。側(cè)(攤8投)沙錯(cuò)誤處理。守一定要對(duì)可符能出現(xiàn)的錯(cuò)結(jié)誤進(jìn)行處理必，以避免故表障引起停機(jī)索。俊4餡.滅序言性注釋駕格式（頭注兔釋）朗頭注釋可以迫大致分為文妖件注釋、模垂塊注釋、數(shù)狂據(jù)注釋等。下在寫注釋時(shí)誓推薦使用以胡下格式。昂文件注釋（盈文件頭）,寺文件注釋記槽述以下信息隨說明：彼“汁”畏表示標(biāo)準(zhǔn)項(xiàng)嫂目，篩“悅”罪表示可選項(xiàng)秀目。葉模塊注釋（爬模塊頭）。派模塊注釋對(duì)蒜了解模塊的窩概要非常有態(tài)效，而且在六維護(hù)時(shí)也同跳樣有效，所槍以一定要記寨述。模塊注螞釋記述以下津信息冶模塊名漸模塊編號(hào)津版本信息俱簡(jiǎn)介飄功能說明區(qū)影響宅注意事項(xiàng)羅返回值扮參數(shù)說明約擔(dān)當(dāng)哪創(chuàng)建信息啞更改記錄種MODUL陽(yáng)E距ID變VERSI克ON康A(chǔ)BSTR命ACT脈FUNCT虧ION姥SIDE-倒EFFEC臟T珍NOTE貍RETUR宵N燥ARGUM副ENT杰AUTHO互R鞋CREAT校E琴UPDAT踐E酒說明：運(yùn)“敘”咽表示標(biāo)準(zhǔn)項(xiàng)豆目，志“織”馳表示可選項(xiàng)途目。數(shù)據(jù)注釋畫數(shù)據(jù)注釋用友來幫助對(duì)數(shù)尊據(jù)結(jié)構(gòu)或數(shù)延據(jù)表、數(shù)組項(xiàng)等內(nèi)容的理乒解?？顦?biāo)識(shí)符名（攪用于標(biāo)識(shí)符細(xì)定義）口數(shù)據(jù)結(jié)構(gòu)名剝稱易數(shù)據(jù)類型跟簡(jiǎn)介濟(jì)注意事項(xiàng)炒TAG飾DATA吃DATA-刻TYPE核ABSTR拋ACT戶NOTE織說明：榴“淘”齒表示標(biāo)準(zhǔn)項(xiàng)薯目，震“憲”繞表示可選項(xiàng)階目。輕附錄:頭腹注釋樣例劃以下為C語(yǔ)土言源文件的虹注釋樣例宋主模塊文件問頭（程序的避主模塊耳，生成命令澇程序。）突/****球*****悔*****喘*****蟲*****舌*****稈*****軌*****避*****荷*****嶼*****對(duì)*****銹****/留/*段怎*/哄/*三惱系統(tǒng)：遭差環(huán)系統(tǒng)名仙工增*/惡/*學(xué)武用戶：征享?yè)в脩裘麪敱碛?/顧/*翻紀(jì)程序：百動(dòng)疑程序名墓軍-桌使標(biāo)題工揪快*/囑/*媽毛擔(dān)當(dāng)部門：霧XXXX嚼謊*/裝/*萄達(dá)弱YYY樓Y端近*/叫/*(C芳)Copy苦right獲Shen醋yang則NETS鼠integ犯ratio破nCor桶porat炸ion1雨996嚷證*/漸/*貢草綢碑All矮Right隔sRes俘erved竊.蛇贈(zèng)彩頂買*/修/****汗*****萌*****康*****畏*****母*****聲*****喚*****淚*****倉(cāng)*****夸*****零*****浮****/列/*V柿ERSIO漸NDA深TE謙BY船北匹C字HANGE擁/COMM幟ENT黨沸*/爸/*綱VX.00港商YY-MM脆/DD禾豐姓名憲Cre更ate烏赴*/系/*池VX.XX偏委YY-MM揉/DD泄攪姓名共耍更改評(píng)勞概要、更改剩理由貨掙*/啊/****筒*****賣*****淘*****麻*****辰*****厭*****及*****宰*****愉*****較*****征*****策****/番/*你功能概略：茅功能概略蕉知肝寺設(shè)某恒話期*/蠟/*繞異常處理：段異常處理氧龍坑福撫費(fèi)帶肯果*/選/*蚊調(diào)用方法：拍駱臨席但裂晝其茅射軋*/刮/*草笨程序名樣躁Arg1憶向Arg2救勵(lì)枝壘夢(mèng)品即*/外/*貧參數(shù)說明：貌尖偉愁注坦焦鞠啄字盾*/常/*矛I/0亡估式參數(shù)名安仙內(nèi)容侄押憂劃營(yíng)鉗束*/斑/*程該I努岔悅Arg1邁箭障內(nèi)容說明耕哥茫筑似清*/插/*萬(wàn)彩I萌窄鬧Arg2歪氏禍內(nèi)容說明賴德邁持允牢*/適/*貓適用計(jì)算機(jī)缺：副計(jì)算機(jī)類型逝、型號(hào)雙栗臂駐錯(cuò)后匯耽*/書/*O門S避：竹克筐OS所名稱（版本惡）貍弦攻腐喪鄙億診*/堂/*舉大?。貉v內(nèi)存航晌珍遵MB夜嬌豈索易發(fā)*/蜂/*林喂顆斑交換份祥捧漸MB亞葬幼苗今袖*/劈/*借編譯：粘挨雅編譯系統(tǒng)名爆稱（版本）反掛所戴葛*/蟲/*番連接信息：璃盈連接信息膽忠悼逮住曉駁看惜*/暗/****秋*****濟(jì)*****非*****很*****礙*****特*****爬*****框*****雄*****妖*****奶*****悔****/趟/*禮齡*/此/*辣請(qǐng)注意：未出經(jīng)許可，不澤可擅自使用急、轉(zhuǎn)載本內(nèi)午容的一部分價(jià)或全部。貢令*/狼/*旁象*/崖/****翁*****柄*****系*****豬*****盲*****美*****滿*****碎*****汗*****使*****選*****府****/橋模塊文件頭狹（從屬模塊牢）搭/****等*****漢*****威*****箱*****并*****秀*****疾*****嘆*****童*****好*****喪*****佩****/汽/*喪寸*/玉/*釋稀系統(tǒng)：損鐵系統(tǒng)名做埋的珍扒碗油針達(dá)爆臘*/寬/*混飼用戶：胳曲用戶名椅較緒肌陳由禮燙襖定停*/明/*判連模塊：帖梅模塊名寬-勾標(biāo)題伐擋吹呆勇慧姐*/嫩/*爺精所屬：蒜籌主模塊名或紫程序名千梯溝陸州盆*/楊/*家路擔(dān)當(dāng)部門：尸XXX愛X域艦筐游孫忍裹描扁*/渾/*鄭幸紹YY嘆YY朝谷法德稻老灶花片*/洗/*(C設(shè))Copy咽right誤Shen啟yang依NETS約Integ配ratio繪nCor博porat教ion1蘋996構(gòu)拒*/濕/*嫌再丑All塵Right遼sRes渣erved宮.遙提騙螞矮項(xiàng)*/吩/****掛*****棍*****紡*****么*****箭*****木*****諒*****汁*****毒*****糠*****禽*****漲****/和/*熊VERSI赤OND觀ATE熄B作Y則屬C址HANGE盲/COMM障ENT桌殲寸*/絨/*想VX.00橋擦YY-MM判/DD如禁姓名鎮(zhèn)Cr待eate霞鼠妥監(jiān)敗*/驗(yàn)/*考VX.XX炸艘YY-MM著/DD肯滋姓名主寄更改概要、腎更改理由滑琴史局*/違/****譜*****插*****如*****這*****繞*****昏*****轉(zhuǎn)*****把*****顏*****暴*****絕*****千****/巡/*反功能概略：額功能概略怒煮扎更曲刷臥桑遇*/疫/*耕異常處理：鞋異常處理?yè)嶂菣褋砝K雹似誦影*/挺/*仁調(diào)用順序：射眠魯扁輸剖洋督育丹躺*/華/*惑下屢int創(chuàng)憑矩I1領(lǐng)部拖闖糟旬喜*/憤/*慮處蛾:賊用腐做壘區(qū)甲抹跌道*/炕/*垮富淡char滴乳蓮01雁溉蒙滲煮旁微*/傷/*黨浙捧sts師=(&I廁1,...輛.,&01今);默嶄團(tuán)糟頃剪*/逝/*富參數(shù)說明：野釀同存笑賠酸溫談武邊*/恢/*旁I平/0翅寄變量名央序欄內(nèi)容百零惑兩撒膝馬*/縣/*頸荷I鉛I票1營(yíng)坡內(nèi)容說明品端構(gòu)美脫傘*/倍/*湊疫:殃欣懷袍巧拋嘗脖緊從春*/粱/*拍涼I私0展1獻(xiàn)惠內(nèi)容說明承澇旺灰菊炕*/紀(jì)/*唱證0予S雖TS排招內(nèi)容說明意內(nèi)字姐香借*/蠻/*銷適用計(jì)算機(jī)誰(shuí)：波計(jì)算機(jī)類型竭、型號(hào)混狐冊(cè)洞字蘆放丈泳*/貸/*O獎(jiǎng)S超：唱新齡OS障名稱（版本秋）睛傻鋸賓碼珍測(cè)奏獨(dú)*/督/*浸編譯：難狂間編譯系統(tǒng)（察版本）詢示牙耕駁爽惡妄騾*/貞/*五連接信息：綢始連接信息嘗輔君嶼良冬付氧曾魔*/聯(lián)/****題*****油*****杜*****搜*****沸*****碼*****團(tuán)*****幫*****作*****撕*****連*****沸****/設(shè)/*豐請(qǐng)注意：未婦經(jīng)許可，不套可擅自使用稿、轉(zhuǎn)載本內(nèi)順容的一部分犁或全部。寬動(dòng)*/忽/****賽*****祥*****忘*****棄*****露*****釋*****略*****客*****毀*****害*****映*****塊****/文件頭例努/*清*Co欲pyrig攔ht1誤994-1配995頓Micro霞soft臭Corpo悲ratio糖n.A暖llRi報(bào)ghts準(zhǔn)Reser誘ved.雞*亭境PROGR樂AM:森身winpr破og.c怠*殿*禿黃PURPO廉SE:帖究Windo麗wspr縱ogram楊.暮*某*選弱PLATF撥ORMS:盟雀Windo仙ws95賣*陵*濫爺FUNCT績(jī)IONS:表*個(gè)元店WinMa怕in()欺-cal山lsin存itial縣izati眾onfu踐nctio學(xué)n,pr火ocess如esme員ssage理loop漂*害聞稼InitA粒pplic字ation更()-害Initi翠alize偏swin災(zāi)dowd需atan克dreg廳ister駐swin魚dow融*鎮(zhèn)標(biāo)演InitI損nstan遲ce()橡-save婚sins猶tance器hand寧lean推dcre剛ates筆main欠windo全w射*拐刮寫MainW快indPr尖oc()您Proce援sses聰messa桌ges檢*購(gòu)染冷About訊()-輪Proce搏ssme鞋nssag巨esfo汁r"Ab制out"睡dialo三gbox勁*/模塊頭1截/*蛙*子川MODUL踏E娛竊:mai配n諸鳴*砌招VERSI染ON困熔:1.1儲(chǔ)*興曉ABSTR陰ACT舟雅:mai邊nfun洽ction生ofp艙rogra愧m瘋*巴劉FUNCT半ION山督:fun配ction并ofm喊ain饅*崇宏ARGUM爸ENT荒授:夠*堆員季勾argc毛屋count會(huì)ofc分omman渴dlin陽(yáng)earg昨ument箭*肺唱猛象argv尿[]喪芒comma蒼ndli揀near轉(zhuǎn)gumen特t渴*爬捐RETUR景N寧感:無(wú)*遇陷機(jī)沖0脾徹norma箏lend舞*慶料汽倆1草倚abnor瞇male潛nd彈*頓內(nèi)SIDE-壺EFFEC環(huán)T次耳:策*群盆NOTE餅污邀:貢*孫胡CREAT竊E弟答:96-產(chǎn)07疑劣附Nets1越*妖稱UP