資源描述：
《Siebel實施規(guī)范-編碼規(guī)范》由會員上傳分享，免費在線閱讀，更多相關(guān)內(nèi)容在工程資料-天天文庫。
1、Siebel實施規(guī)范編碼規(guī)范編寫人：張遠舟日期：2010-7-5一、簡介11.目的12.適用范圍1二、編程規(guī)范11?總體規(guī)范I2.代碼格式規(guī)范13.代碼注釋規(guī)范14.命名規(guī)范35.邏輯穩(wěn)定規(guī)范45.性能效率規(guī)范5三、代碼Review規(guī)范51.代碼Review的目的52.代碼Review方法53.代碼Review規(guī)范5一、簡介1.目的本文的0的在于為漢得Siebel技術(shù)團隊的編碼規(guī)范提出意見和參考。2.適用范圍木規(guī)范（草稿）應(yīng)用于Siebel實施項目中使用E-Script進行的編碼的腳木開發(fā)。編程規(guī)范1?總體
2、規(guī)范【規(guī)范1］優(yōu)先考慮編碼的可替代方案（UserProperty,ModelState,Validation等）【規(guī)范2】時刻考慮到你的每一個編碼都會由其他的人在其他的時間使用、維護、增強【規(guī)范3］以不懂程序的人都能讀懂你的代碼為編碼的最基本目標和要求【規(guī)范4】盡量使你的程序容易被調(diào)用（重用），修改和擴展【規(guī)范5】合理地捕獲和處理異?！疽?guī)范5】新創(chuàng)建的對象需要在代碼結(jié)束時顯式釋放【規(guī)范6】效率是永遠需要重點考慮、分析和優(yōu)化的問題點【規(guī)范7】把相關(guān)的邏輯封裝在BS中，避免代碼分散冗余，增加維護成本2.代碼格式
3、規(guī)范【規(guī)范1】單行代碼不得太長，盂便于閱讀，太長的代碼行盂要在適合的位置斷行【規(guī)范2】每行代碼最多包含一個獨立的語句。【規(guī)范3】代碼塊之間使用Tab縮進一次【規(guī)范4】一個方法的代碼語句不宜過多，復(fù)雜的邏輯使用拆分成幾個獨立的Function來實現(xiàn)，并確保一個Function只做一件獨立的事情?！疽?guī)范5】每一?個變量的聲明獨占一行，變量的聲明置于代碼塊開始位置?！疽?guī)范6】在邏輯塊、代碼塊Z間合理便用單個空行3.代碼注釋規(guī)范【規(guī)范1】適當?shù)鼐帉懘a注解，增強代碼的可讀性和可維護性說明：一般情況下，程序或Func
4、tion的作用，參數(shù)，創(chuàng)建和修改信息等都需要通過注釋來標識，便以便用、維護和管理。程序小的邏輯塊、復(fù)雜算法、重要變量的意義等也需要用注釋來說明?！疽?guī)范2】在修改代碼的同吋，修改代碼注釋。說明：代碼被修改后，必須同步修改代碼注釋，已實現(xiàn)注釋的正確指導(dǎo)意義。代碼頻繁被改動但注釋不變是容易導(dǎo)致歧義的根源Z-o【規(guī)范3】注釋必須有但是不能過度。并不需要為每一句代碼、每一個變蜃使用一句注釋，這樣反而使得代碼變得兀長累贅而不易維護。一般只在關(guān)鍵點使用注釋?！疽?guī)范4】方法注釋規(guī)范。方法注釋用于說明方法文件的一些基本信息，
5、包括方法的作用，參數(shù)，返回值，創(chuàng)建者和創(chuàng)建日期，更新者和更新日期，代碼版木等。如對FunctionSubmitOrder(orderId)注釋如卜：/**Function:ToSetTheStatusofTheSpecifiedOrdertoBe"Submitted，*?Paramlorderld:TheIdValueofTheSpecifiedOrder*?Return:trueifsuccess,otherwisefalse*Author：Neo.Zhang*Created：6/10/2010*Last
6、UpdatedBy：Neo.Zhang*LastUpdated:7/5/2010*Modifications:*1.AddValidationtoMakeSureOrderTypeIsPurchaseOrderon6/12/2010ByNeo.Zhang*2.CommentedtheCodeBlockofPurchaseHistoryAccumulationon7/5/2010ByNeo?Zhang*Version:1.2*/注禪可根據(jù)項目環(huán)境選擇使用屮文或英文。【規(guī)范5】變量注釋規(guī)范以下情況，變量需要使用
7、注釋：1.常量，尤其是業(yè)務(wù)常量2.采用了不容易被理解的縮寫作為變量名的變量3.程序邏輯中重要的核心變量4.作為方法返回值的變量5.變量注釋的格式為在變量聲明的上一行使用〃注釋如：//ADictionaryArraytoStoreOrderQuantityofProductIdvaraProdQty=[];【規(guī)范6】不要編寫修飾性的注釋。不要使用類似以下的注釋。因為腳木具有最大字節(jié)數(shù)限制，這樣的注釋將占用大量字節(jié)數(shù)，且顯得累贅多余。/**************************************
8、*****************************ThisCodeBlockDealsWiththeRMABusiness【規(guī)范7】在具有復(fù)朵算法或復(fù)雜邏輯的代碼塊前，說明其算法或邏輯。例如：/**以下的代碼用于計算維修店計劃建議表數(shù)據(jù)，具體邏輯是…*…【規(guī)范8】對于臨時代碼或棄用代碼，需要注釋掉并說明注釋原因，不可玄接刪除。臨時代碼是指現(xiàn)在不使用，但是將來有可能被啟用的代碼。棄用代碼是指原來使用，但是現(xiàn)
