聯(lián)合公司X++編碼規(guī)范

1、聯(lián)合公司X+開發(fā)及編碼規(guī)范聯(lián)合公司X+開發(fā)及編碼規(guī)范聯(lián)合公司信息管理部修訂歷史時(shí)間版本說明作者2014-8-80.1初稿陳榮目 錄1.概要說明41.1.目標(biāo)41.2.使用范圍41.3.術(shù)語41.4.參考資料42.開發(fā)流程42.1.流程圖43.命名規(guī)范54.編碼規(guī)范95.注釋規(guī)范146.備份211. 概要說明1.1. 目標(biāo)為保證聯(lián)合公司及下屬企業(yè)AX系統(tǒng)二次開發(fā)能夠按照一定規(guī)范進(jìn)行，特制定本編碼規(guī)范。1.2. 使用范圍聯(lián)合公司及下屬企業(yè)AX系統(tǒng)二次開發(fā)。1.3. 術(shù)語1.4. 參考資料微軟Dynamics AX 2009 開發(fā)培訓(xùn)教材2. 開發(fā)流程2.1. 流程圖不通過通過開發(fā)測試環(huán)境生產(chǎn)環(huán)境測

2、試1. 對(duì)于每一個(gè)項(xiàng)目都應(yīng)該建立兩個(gè)環(huán)境，即開發(fā)測試環(huán)境和生產(chǎn)環(huán)境。2. 開發(fā)測試環(huán)境必須測試通過后才能進(jìn)入下一個(gè)環(huán)境。3. 所有開發(fā)人員必須在統(tǒng)一的開發(fā)測試環(huán)境中進(jìn)行開發(fā)，不能在本機(jī)獨(dú)立環(huán)境中開發(fā)。4. AX中每個(gè)功能模塊必須建立一個(gè)公共類型的project文件夾。5. AX中每個(gè)project文件夾的分類樹結(jié)構(gòu)必須與系統(tǒng)的AOT結(jié)構(gòu)保持一致。6. 每個(gè)開發(fā)人員必須使用自己的AX賬戶登錄。7. Application命名方式：a) 開發(fā)測試環(huán)境：客戶名/模塊名“Dev”。如：AX ApplicationApplLS Devb) 生產(chǎn)環(huán)境：客戶名/模塊名。如：AX ApplicationApp

3、lLS3. 命名規(guī)范1. 標(biāo)識(shí)符的命名要清晰、明了，有明確含義，同時(shí)使用完整的單詞或大家可以理解的縮寫，避免使人產(chǎn)生誤解。說明：較短的單詞可通過去掉“元音”形成縮寫；較長的單詞可取單詞的頭幾個(gè)字母形成縮寫；一些單詞有大家公認(rèn)的縮寫。示例：如下單詞的縮寫能夠被認(rèn)可。temp縮寫為 tmp;flag縮寫為 flg;statistic縮寫為 stat;increment縮寫為 inc;message縮寫為 msg;2. 命名中若使用特殊約定或縮寫，則要有注釋說明。說明：應(yīng)該在程序的開始之處，對(duì)程序中所使用的縮寫或約定，特別是特殊的縮寫，進(jìn)行必要的注釋說明。綴or(void ointLocationI

4、dFlag) 3. 變量命名，除了有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但i、j、k作局部循環(huán)變量是允許的。變量命名可以采用同義的英文命名，可使用幾個(gè)英文單詞，單詞的首字母必須大寫。局部變量加“m_”前綴，全局變量加“g_”前綴，參數(shù)變量加“_”前綴。說明：變量，尤其是局部變量，如果用單個(gè)字符表示，很容易敲錯(cuò)（如i寫成j），而編譯時(shí)又檢查不出來，有可能為了這個(gè)小小的錯(cuò)誤而花費(fèi)大量的查錯(cuò)時(shí)間。示例：正確的變量名的定義方法：CustTablem_CustTable；（局部變量）CustTableg_CustTable；（全局變量）CustTable_CustTable;（參數(shù)變量）4. T

5、able采用前綴標(biāo)識(shí)符后綴的方式?？梢栽谧钋懊婕由享?xiàng)目代號(hào)（客戶代號(hào)）和下劃線。常用的前綴后綴有： DEL_*：不再使用的表。如：DEL_HRMJobTmp*：臨時(shí)表。如：TmpABC，TmpBOM*Trans：事務(wù)表。如：CustTrans，VendTrans，InventTrans*Jour： 日記賬表。如：CustInvoiceJour，VendInvoiceJour*Line：明細(xì)表。如：SalesLine，PurchLine*Table：主表。 如：CustTable，SalesTable，PurchTableCom_TmpABC5. Index采用標(biāo)識(shí)符加Idx后綴的方式。6. M

6、aps采用標(biāo)識(shí)符加Map后綴的方式?？梢栽谧钋懊婕由享?xiàng)目代號(hào)（客戶代號(hào)）和下劃線。如：BOMMap，MyTableMap，Com_BOMMap7. View（視圖）采用標(biāo)識(shí)符加View后綴的方式?？梢栽谧钋懊婕由享?xiàng)目代號(hào)（客戶代號(hào)）和下劃線。如：CustView，MyTableView，Com_CustView8. EDT（擴(kuò)展數(shù)據(jù)類型）采用有意義的單詞組合，單詞首字母要大寫?？梢栽谧钋懊婕由享?xiàng)目代號(hào)（客戶代號(hào)）和下劃線。如：Amount，ItemId，CustAccount9. Base Enum（枚舉）采用Enum加標(biāo)識(shí)符的方式，避免跟EDT同名。在最前面加上項(xiàng)目代號(hào)（客戶代號(hào)）和下劃線。

7、如：EnumXY，Com_EnumXY10. Feature Keys，License Codes，Configuration Keys，Security Keys，Table Collections，Macros，Classes，F(xiàn)orms，Reports，Queries，Jobs，Menus，Menu Items采用有意義的單詞組合，單詞首字母要大寫?？梢栽谧钋懊婕由享?xiàng)目代號(hào)（客戶代號(hào)）和下劃線。說明：From：From的名字可以跟Table同名，并且如果有一個(gè)主表一般都會(huì)有個(gè)同名的窗體。例如：SalesTable，CustTable。Class：Class不能與Table，EDT，Bas

8、eEnum的名字相同。Report：Report的名字不受限制，可以跟Table，F(xiàn)orm，Class的名字同名。11. 方法的命名應(yīng)全部使用有意義的單詞組成，并且除了首單詞首字母小寫外，其他單詞的首字母應(yīng)該使用大寫字母。說明：設(shè)置變量內(nèi)容的方法，應(yīng)使用Set作為前綴，例如：str setUserName(str _userName)讀取變量內(nèi)容的方法，應(yīng)使用Get作為前綴，例如：str getUserName()設(shè)置和讀取變量內(nèi)容的方法，應(yīng)使用parm作為前綴，例如：str parmUserName(str _userName = “”)示例：main，new，dialogaddName，p

9、armPrice，queryRun12. 不要用數(shù)字或較奇怪的字符來定義標(biāo)識(shí)符。示例：如下命名，使人產(chǎn)生疑惑。#define._EXAMPLE_0_TEST_(0)#define._EXAMPLE_1_TEST_(1)void setVar00(boolean var); 應(yīng)改為有意義的單詞命名#define._EXAMPLE_UNIT_TEST_(0)#define._EXAMPLE_ASSERT_TEST_(1)void setUnitTest(boolean var);13. 用正確的反義詞組命名具有互斥意義的變量或相反動(dòng)作的方法。說明：下面是一些在軟件中常用的反義詞組。add

10、 / remove begin / end create / destroy insert / delete first / last get / releaseincrement / decrement put / getadd / delete lock / unlock open / closemin / max old / newstart / stopnext / previoussource / targetshow / hidesend / receivesource / destinationcut / pasteup / downparm(Axapta常用的前綴)示例：int

11、 m_MinSum;int m_MaxSum;int addUser(str _userName)int deleteUser(str _userName)int parmUser(str _userName = userName)4. 編碼規(guī)范排版1. 程序塊要采用統(tǒng)一的縮進(jìn)風(fēng)格編寫，縮進(jìn)1個(gè)Tab即4個(gè)空格說明：對(duì)于由開發(fā)工具自動(dòng)生成的代碼可以有不一致。2. 相對(duì)獨(dú)立的程序塊之間、變量說明之后必須加空行示例：如下例子不符合規(guī)范。if (!Valid(Null) . / program codeSalesLine.SalesPrice= SalesPrice;SalesLine.SalesQ

12、ty= SalesQty; 應(yīng)如下書寫if (!ValidNull(Null) . / program code SalesLine.SalesPrice= SalesPrice;SalesLine.SalesQty= SalesQty;沒看出差異是什么3. 較長的語句（超過屏幕寬度）要分成多行書寫，長表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首，劃分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語句可讀性高示例：returnAmount = (qtyNow * (price - discAmount) / priceUnit) + (qtyNow >= 0 ? m

13、arkup : -markup) ) * (100 - discPercent) / 100;PriceFlag= !price && !discAmount && !discPercent && !markup&& !forceAmountCalculation4. 循環(huán)、判斷等語句中若有較長的表達(dá)式或語句，則要進(jìn)行適應(yīng)的劃分，長表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首，保持縮進(jìn)原行之尾示例：if (taskno < maxActTaskNumber) && (n7statStatItemVa

14、lid (statItem) . / program code for (i = 0, j = 0; (i < BufferKeyword.wordLength) && (j < NewKeyword.wordLength); i+, j+) . / program code for (i = 0, j = 0; (i < firstWordLength) && (j < secondWordLength); i+, j+) . / program code while select forupdate markupT

15、rans index hint TableRecIdIdx where markupTrans.transTableId= this.tableId && markupTrans.transRecId= this.recId 例子代碼改掉5. 若方法中的參數(shù)較多，每個(gè)參數(shù)要獨(dú)立一行，保持縮進(jìn)4格示例：void buildOneNode(int _parentNodeId, BOMId _BOMId, ItemId _itemId, ConfigId _configId, boolean _recursive = false )void new(FormRun _fr, Form

16、TreeControl _tree, FormListControl _list, FormWindowControl _BOMInfoImage, FormStaticTextControl _BOMInfoText, FormWindowControl _BOMInfoVersionImage, FormWindowControl _routeInfoImage, FormStaticTextControl _routeInfoText, FormWindowControl _routeInfoVersionImage, tableId _callerTableId )修改例子代碼6. 不

17、允許把多個(gè)短語句寫在同一行中，一行只能寫一條語句示例：如下例子不符合規(guī)范。SalesLine.SalesPrice = 0; salesLine.SalesQty = 0; 應(yīng)如下書寫SalesLine.SalesPrice= 0; salesLine.SalesQty = 0;7. if、for、do、while、case、switch、default等語句自占一行，且if、for、do、while等語句的執(zhí)行語句部分無論多少都要加括號(hào)示例：如下例子不符合規(guī)范。if (BOMDesignerCtrl = NULL) return; 應(yīng)如下書寫：if (BOMDesigne

18、rCtrl = NULL) return;8. 程序塊的分界符（如X+語言的大括號(hào)和）應(yīng)各獨(dú)占一行并且位于同一列，同時(shí)與引用它們的語句左對(duì)齊。在方法的開始、類的定義、結(jié)構(gòu)的定義、枚舉的定義以及if、for、do、while、switch、case語句中的程序都要采用以上的縮進(jìn)方式示例：如下例子不符合規(guī)范。for (.) . / program code if (.) . / program code  void ( void ) . / program code  應(yīng)如下書寫。for (.) . / program code if (.) . / pro

19、gram code void ( void ) . / program code5. 注釋規(guī)范備注1. Axapta源程序必須有有效的注釋說明：注釋的原則是有助于對(duì)程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語言必須準(zhǔn)確、易懂、簡潔。2. 注釋格式應(yīng)該統(tǒng)一，為了跟Axatpa本身的注釋保持一致，使用“/”。示例：/ if file was found, it means that other companies use the same directory/ to store the documents. Especially this is critical f

20、or a virtual companies, where/ documents are shared.3. 類的注釋對(duì)類的注釋寫在classDeclaration方法的頭部，注釋必須列出：版權(quán)說明、版本號(hào)、完成日期、作者、內(nèi)容、功能。使用HeadTemplate示例： /Copyright (C), 2005-2006, XXX Co., Ltd./Author: 作者 /Version: 版本 /Date: 完成日期/Description:用于詳細(xì)說明此類完成的主要功能，與其他模塊或方法的接口，輸出值、取值范圍、含義及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系4. 變量的注釋對(duì)于所有有物理含義

21、的變量、常量，如果其命名不是充分自注釋的，在聲明時(shí)都必須加以注釋，說明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。示例：/active statistic task number#define.MAX_ACT_TASK_NUMBER(1000) #define.MAX_ACT_TASK_NUMBER(1000) /active statistic task number對(duì)于每個(gè)變量應(yīng)該注釋，但對(duì)于意義非常明顯的變量，如：i,j等循環(huán)變量可以不注釋。例如：int i；int m_LineCount；  /線的根數(shù)5. 方法和參數(shù)的注釋列出方法的目的、

22、功能、輸入?yún)?shù)、輸出參數(shù)、返回值。使用HeadTemplate示例：/Copyright (C), 2005-2006, XXX Co., Ltd. /Author: 作者 /Version: 版本 /Date: 完成日期 /Description:方法功能、性能等的描述 /Return: 方法返回值的說明 6. 代碼段的注釋在方法內(nèi)我們不需要注釋每一行語句。但必須在每一主要部分之前添加塊注釋，注釋每一組語句，在循環(huán)、流程的各分支等。其中的循環(huán)、條件、選擇等位置必須注釋。 對(duì)于前后順序不能顛倒的情況，要在注釋中增加序號(hào)。例如： ./1、.注釋for (.)if(.

23、)/.注釋else/.注釋/.注釋switch(.) case: ./ .注釋 .  case: ./ .注釋 . default:    /.注釋 .7. 修改記錄的注釋每條修改記錄的注釋應(yīng)包括修改日期、修改者及修改內(nèi)容簡述。/History: / 1. Date:/ Author:/ Modification: / 2. .8. 邊寫代碼邊注釋，修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致性。不再有用的注釋要?jiǎng)h除9. 注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性說明：錯(cuò)誤的注釋不但無益反而有

24、害。10. 不能使用沒有說明和不常用縮寫說明：在使用縮寫時(shí)或之前，應(yīng)對(duì)縮寫進(jìn)行必要的說明。11. 注釋應(yīng)與其描述的代碼相近，對(duì)代碼的注釋應(yīng)放在其上方或右方（對(duì)單條語句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開示例：如下例子不符合規(guī)范。例1：/ get replicate sub system index and net indicator  repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni; 例2：repssn_ind = ssn_dataindex

25、.repssn_index;repssn_ni = ssn_dataindex.ni;/ get replicate sub system index and net indicator 應(yīng)如下書寫/ get replicate sub system index and net indicator repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;12. 不能在一行代碼或表達(dá)式的中間插入注釋13. 通過對(duì)方法、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu)，使代碼成為自注釋的說明：清晰準(zhǔn)確的方法、

26、變量等的命名，可增加代碼可讀性，并減少不必要的注釋。Axapta中方法、變量等的命名都非常的有意義，自注釋能力很強(qiáng)，因此注釋并不多。14. 在代碼的功能、意圖層次上進(jìn)行注釋，提供有用、額外的信息說明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者理解代碼，防止沒必要的重復(fù)注釋信息。示例：如下注釋沒有意義。/ if receiveFlag is TRUEif (receiveFlag) 而如下的注釋則給出了額外有用的信息。 / if mtp receive a message from linksif (receiveFlag)15. 在程序塊的結(jié)束行右方加

27、注釋標(biāo)記，以表明某程序塊的結(jié)束說明：當(dāng)代碼段較長，特別是多重嵌套時(shí)，這樣做可以使代碼更清晰，更便于閱讀。示例：參見如下例子。if (.) / program code  while (index < MAX_INDEX) / program code / end of while (index < MAX_INDEX) / 指明該條while語句結(jié)束/ end of if (.) / 指明是哪條if語句結(jié)束16. 注釋與被描述內(nèi)容進(jìn)行同樣的縮排說明：可使程序排版整齊，并方便注釋的閱讀與理解。示例：如下例子，排版不整齊，閱讀不方便。void ( void )/ code o

28、ne comments CodeBlock One  / code two comments CodeBlock Two 應(yīng)改為如下布局。void ( void ) / code one comments CodeBlock One  /code two comments CodeBlock Two17. 將注釋與其上面的代碼用空行隔開。示例：如下例子，顯得代碼過于緊湊。/ code one comments program code one/ code two comments program code two 應(yīng)如下書寫/ code one comm

29、ents program code one / code two comments program code two18. 對(duì)于switch語句下的case語句，如果因?yàn)樘厥馇闆r需要處理完一個(gè)case后進(jìn)入下一個(gè)case處理，必須在該case語句處理完、下一個(gè)case語句前加上明確的注釋。說明：這樣比較清楚程序編寫者的意圖，有效防止無故遺漏break語句。示例（注意斜體加粗部分）：case CMD_UP: ProcessUp(); break; case CMD_DOWN: ProcessDown(); break; case CMD_FWD: ProcessFwd(); if (.) . break;else ProcessCFW_B(); / now jump into case CMD_A case CMD_A: ProcessA(); break; case CMD_B: ProcessB(); br