公司管理系統(tǒng)代碼要求規(guī)范(C#)

實(shí)用文檔實(shí)用文檔大全大全DDDDDDDDDDDD□□□□□□□□□□DDDDDDTOC\o"1-5"\h\z目 錄0、修訂記錄 41、概述 41.1、規(guī)范制定原則 42、基本規(guī)則 4命名法Pascal、Camel 4\o"CurrentDocument"Namespace命名空間規(guī)范 53、文件命名 64、C#語法規(guī)范 7符號(hào)規(guī)范 7換行 7縮口 7\o"CurrentDocument"空行 8\o"CurrentDocument"空格 9\o"CurrentDocument"花括號(hào){} 9代碼注釋 9\o"CurrentDocument"類注釋 9代碼注釋 10命名規(guī)范 104.3.1名稱清晰 10\o"CurrentDocument"4.3.2縮寫詞 11\o"CurrentDocument"4.40000 125、SQL語法規(guī)范 125.1數(shù)據(jù)表命名規(guī)范 12數(shù)據(jù)庫對(duì)象命名規(guī)范 13常用數(shù)據(jù)表前綴建議 13數(shù)據(jù)表字段定義 14代碼書寫規(guī)范 15SELECTD0： 15\o"CurrentDocument"INSERTDO： 15\o"CurrentDocument"UPDATEDO： 15\o"CurrentDocument"DELETEDO： 15\o"CurrentDocument"IFDO： 16\o"CurrentDocument"CASEDO： 16\o"CurrentDocument"WHILEDO： 16附錄：.Net命名規(guī)范 181、變量命名規(guī)范 182、Web控件命名規(guī)范 183、ADO.NET控件命名規(guī)范 194、Html控件命名規(guī)范 19\o"CurrentDocument"5、客戶端JavaScript規(guī)范 206、命名規(guī)則補(bǔ)充 207、命名通則 21□□□□□□版本作者日期說明一、概述1.1、規(guī)范制定原則1、□□□□□□□□□□2、3、1、□□□□□□□□□□2、3、□□□□□□□□□□□□4、代碼的邏輯更清晰、更易于理解。□□□□□□2.1命名法Pascal、Camel□□□□□□Pascal命名法：□□□□□□,□□□□□□//□□□□UserInfo.aspx//類命名publicclassUserInfo(){publicstringBuyApple{...}//□□□□publicstringName{get{return_name;}}}Camel命名法：□□□□□□,□□□□□□□□□□□□,□□□□□□□□,□□：//□□□□UserInfouserInfo=newUserInfo();//□□□□intrecordCount=0;stringuserName="";□□：□□□□□□□□□□，□□□□□ C#.Net□□□□□□2.2Namespace命名空間規(guī)范原則上命名空間層次不要超過 3層最為易于理解，例如：Zsp.ICS.Common.StringManager.Encryption在使用上就非常費(fèi)勁。系統(tǒng)提供功能舉例： Zsp.DbHelperZsp：正卓公司服務(wù)框架前綴DbHelepr：框架級(jí)功能名稱項(xiàng)目應(yīng)用舉例： ICS.CommonAMS.StringProcessor.EncryptionICS、AMS：項(xiàng)目名稱前綴，這里表示《內(nèi)控系統(tǒng)》項(xiàng)目Common、StringProcessor：項(xiàng)目內(nèi)命名空間名稱□□□□□嚴(yán)禁使用拼音命名： publicZhiFu(){}采用Pascal□□□□□□□□□□□□□□□□□□□□□□□□□□□ PrintPageInfo.aspxBudgetInfoManager.aspx□□□□□ Print_Page_Info.aspxBUDGETInfoManager.aspxbudgetinfomanager.aspx四、C#語法規(guī)范符號(hào)規(guī)范DO換行主要目的是為了讓過長的代碼可讀性增強(qiáng)。1、分號(hào)“；”之后必須換行, 正確的方式：inti=0；stringname;錯(cuò)誤的方式：inti=0;stringname;2、口號(hào)“ ，”時(shí)可以換O,如果字符較短可以不換O, 正確的方式：stringsql=string.Format("SELECT*FROMTableNameWHEREID={0}ANDSex={1}",datalD.ToStringO,0);錯(cuò)誤的方式：stringsql=string.Format("SELECT*FROMTableNameWHEREID={0}ANDSex={1}",datalD.ToStringO,0);DD□□□□□□Tab□□□□□□□□ 4,不要使用空格縮進(jìn)代碼， □□□□□：if(true)return;□□□□□：if(true)return;VS可在：“工具>選項(xiàng)>□□□□□ >所有語言>制表符”□□□□□□□,□□□□□□□□：空行在口、接口、枚舉的定義代碼之間需要空一行，便于區(qū)不同區(qū)段。在代碼中適量使用空行，也可以有效增加代碼可讀性。例如：publicclassUserInfo{decimal_money;publicdecimalMoney{set{_money=value;}}publicboolBuy(Appleapple){if(money>100){Money-二100;returntrue;}else{returnfalse;}}publicvoidSell(Appleapple){Money+=100;}}空格空格使用在關(guān)鍵字之后，或運(yùn)算符之間，例如：if(true){ints=1;for(inti=0;i<100;i++){s=s*(i+1);}}花括號(hào){}花括號(hào)通常伴隨著轉(zhuǎn)行：while(true){if(true){//DoSomething}}代碼注釋類注釋每個(gè)類前必須加文檔口釋，只需要打三個(gè) ///號(hào)，SDK會(huì)自動(dòng)生成注釋包含框，然后在其中輸入注釋：///<summary>〃/這是自動(dòng)生成的文檔注釋///</summary>publicvoidGetName(){}代碼注釋代碼注釋需要保持在功能實(shí)現(xiàn)之前， 正確的例子：if(true)//如果條件為真{〃設(shè)置狀態(tài)值status="執(zhí)行中 ";return;}或者〃如果條件為真if(true){//設(shè)置狀態(tài)值status="執(zhí)行中 ";return;}錯(cuò)誤的例子：if(true){//如果條件為真stringstatus="執(zhí)行中";//設(shè)置狀態(tài)值return;}命名規(guī)范名稱清晰嚴(yán)禁使用拼音命名： publicZhiFu(){}也就是說必須清晰描述方法的意義，類、方法的命名應(yīng)盡量說明作用是什么， 而不是如何做，也就是說必須清晰描述方法的意義，例如：TeacherInfo();而不是ObjectInfo();RemoveStudent(intindex);而不是RemoveArrayElement(intindex);□□□□□□□□□□□□,□□：DrawPoint(intx,inty);而不是DrawPoint(inta,intb);UserLogin(stringname,stringpass);而不是UserLogin(stringstrl,stringstr2);避免使用難懂的名稱和容易忘記的名稱，例如：publicSPD();publicSyncThis();避免重復(fù)命名，例如：Book.BookTitle應(yīng)該修改為Book.Title布爾變量應(yīng)包含 Is關(guān)鍵字，例如：publicboolIsChecked{get;}boolisChecked=true;boolfileIsDeleted;縮寫詞縮寫是經(jīng)常遇到的情況， 一個(gè)類名太長， 也會(huì)導(dǎo)致閱讀困難， 此時(shí)應(yīng)使用適當(dāng)縮寫，縮寫詞應(yīng)當(dāng)遵從通用性原則，也就是使用大家共識(shí)性的單詞縮寫，而不要自己創(chuàng)造縮寫。1、短名稱應(yīng)使用全稱而不要使用縮寫，例如：GetWindow()不要寫為GetWin()2、眾所周知，沒有歧義的單詞則應(yīng)盡量使用縮寫，例如：Userinterface應(yīng)縮寫為UI3、部分過長名稱可以使用部分單詞沒有歧義的縮寫詞代替，例如：GetAdministratorInformation();可縮寫為GetAdminInfo();或GetAdmInfo();3、使用大小寫規(guī)則時(shí)，僅兩個(gè)字的縮口盡量使用全大口，而不要使用駝峰規(guī)則，例如：UI不要寫為Ui,IO不要寫為Io,ID不要寫為Id0000除了字段名稱對(duì)應(yīng)的控件外， 使用Camel0名法，采取首字母小寫， 連接單詞均首字母大寫000,00：頁面中的 GridView0名為budgetDataList對(duì)應(yīng)數(shù)據(jù) F_Name字段的 TextBox00,0名為 F_Name與數(shù)據(jù)庫無關(guān)的搜索錄入關(guān)鍵字的 TextBox00,0名為 txtKeyword提交表單的按鈕 Button00,0名為btnSubmit可參考附錄 .Net00規(guī)范：五、SQL語法規(guī)范數(shù)據(jù)表00規(guī)范所有數(shù)據(jù)表均以“ T”開頭，以下劃線分隔00空間后三位為模塊縮寫，使用大寫字母,00系統(tǒng)模塊使用“ SYS”然后就是表的具體功能性名稱,00系統(tǒng)日志表“ SystemLog”00：T_SYS_SystemLog

基礎(chǔ)數(shù)據(jù)表命名后綴規(guī)范表作用后綴范例說明基礎(chǔ)信息表InfoT_YBS_BudgetInfo年預(yù)算模塊預(yù)算信息表子表DetailT_YBS_BudgetDetail年預(yù)算模塊預(yù)算明細(xì)表連接表LinkT_AUT_UserGroupLink授權(quán)模塊用戶組連接表日志表LogT_YBS_BudgetModifyLog年預(yù)算模塊預(yù)算修改日志表業(yè)務(wù)邏輯表無T_YBS_BudgetMergeApply名稱必須能準(zhǔn)確描述業(yè)務(wù)T_WF_WorkFlowStep數(shù)據(jù)庫對(duì)象命名規(guī)范本規(guī)范定義了數(shù)據(jù)庫中的表、視圖、存儲(chǔ)過程等對(duì)象的命名規(guī)范，要求必須遵守。基本規(guī)則： ＜前綴＞_＜模塊縮寫 ＞_＜功能名稱 ＞（字段命名不要求模塊縮口）對(duì)象英文前綴范例數(shù)據(jù)表TableT_T_AUT_UserInfo視圖ViewV_V_AUT_GetUserWithRoleInfo□□□□USPUSP_USP_AUT_GetUserRoleLink函數(shù)FunctionFN_FN_Split□□□□□字段FieldF_F_Password主鍵PK_PK_DataID外鍵FK_FK_ParentID索引IDX_IDX_Code□□□□□□觸發(fā)器TriggerTR_同義詞SynonymSY_□□□□□LS_端點(diǎn)PS_□□□□ 及函數(shù)□□□□□參數(shù)用Pascal□□□□ @UserID臨時(shí)表用Pascal□□□□ #UserList□□□□□用Pascal□□□□□□□： ##TMP_5.3常用數(shù)據(jù)表前綴建議本建議的目的是為常用模塊定義共識(shí)性的縮寫詞：

表格類型縮寫前綴備注字典DICT_DIC_授權(quán)模塊AUTT_AUT_系統(tǒng)信息SYST_SYS_公司框架ZSPT_ZSP_累計(jì)表SUMT_SUM_業(yè)務(wù)BLLT_BLL_業(yè)務(wù)可根據(jù)實(shí)際名稱名稱縮寫詞，□□□□□□□ T_PR卬年□□□□□ T_YBS5.4數(shù)據(jù)表字段定義字段數(shù)據(jù)類型系統(tǒng)類型初始值說明F_IDintInt32主鍵/自增編號(hào)F_SNuniqueidentifierGuid□□□□□業(yè)務(wù)字段F_IsDelintInt32標(biāo)識(shí)刪除F_Creatorvarchar(32)String創(chuàng)建人F_CreateDatedatetimeDateTime創(chuàng)建時(shí)間F_Updatervarchar(32)String更新人F_UpdateDatedatetimeDateTime更新時(shí)間F_StatusintInt32狀態(tài)標(biāo)識(shí)所以字典表及業(yè)務(wù)表（連接關(guān)系表除外），數(shù)據(jù)必須按以下規(guī)范建立，并包含以下字段：字典表關(guān)聯(lián)必須使用 F_ID,并應(yīng)建立層次路徑描述。例如：樹形結(jié)構(gòu)的數(shù)據(jù)表，外鍵字典關(guān)系。F_IDF_PIDF_PathF_LayerF_Text100Text12111Text2321/22Text3業(yè)務(wù)表關(guān)聯(lián)必須使用F_SN,用以確保數(shù)據(jù)序號(hào)的唯一性和遷移的方便性。例如：主子表結(jié)5.5代碼書寫規(guī)范SELECT語句：SELECTT1.F_Col1,T1.F_Col2,T1.F_Col3,T2.F_Col1,T2.F_Col2FROMT_Table1AST1INNERJOINT_Table2AST2ONT2.F_PID=T1.F_IDANDT2.F_Col5=ConditionValueWHERET1.F_Col2=ConditionValueGROUPBYT1.F_Col1,T1.F_Col2,T1.F_Col3,T2.F_Col1,T2.F_Col2ORERBYT1.F_Col1,T1.F_Col2DESC;INSERTDO：INSERTINTOT_Table1(F_Col1,F_Col2,F_Col3)VALUES(Valuel,Value2,Value3);UPDATEDO：UPDATET_Table1SETF_Col1=valuel,F_Col2=value2FROMT_Table1AST1WHERET1.F_Col3=CondtionValueDELETEDO：DELETEFROMT_Table1大全大全實(shí)用文檔WHEREF_Col1=ConditionValueIF語句：IF(Condition。BEGINProgramBlock;ENDELSEIF(Condition2)BEGINProgramBlock;ENDELSEBEGINProgramBlock;END;CASE語句：CASE([Express])Result1Result2Result1Result2Result3WHEN (Condition2 or Value2) THENWHEN (Condition3 or Value3) THENELSEResult4END;WHILE語句：WHILE(Condition)BEGINProgramBlock;[BREAK;][CONTINUE;]END;實(shí)用文檔實(shí)用文檔大全大全□□□□□□□□□□□□ODDCommit)提交修改時(shí)，必須注明所提交的修改內(nèi)容，并使用符號(hào)標(biāo)識(shí)說明文字符號(hào)標(biāo)識(shí)規(guī)范0000： +增加功能；一減少功能；*修正錯(cuò)誤一次提交的說明范例：+增加開支記錄報(bào)表打印頁面一刪除殘留已無法使用的項(xiàng)目管理模塊*修正開支記錄報(bào)表頁面搜索條件報(bào)錯(cuò)的問題注意：說明文字應(yīng)正確清晰，不要出現(xiàn)“增加一個(gè)報(bào)表”等類似的文字附錄：.Net命名規(guī)范1、變量命名規(guī)范類型前綴示例ArrayarrarrShoppingListboolbBooleanblnblnIsPostBackBytebytbytPixelValueCharchrchrDelimiterDateTimedtmdtmStartDateDecimaldecdecAverageHeightDoubledbldblSizeofUniversefloatfltIntegerIntintRowCounterLonglnglngBillGatesIncomeObjectobjobjReturnValuesbytesbShortshr、shtshrAverageSinglesngsngMaximumStringstrstrFirstNameuintuiulongul2、Web控件命名規(guī)范類型前綴示例AdRotatoradrtadrtTopAdButtonbtnbtnSubmitCalendarcalcalMettingDatesCheckBoxchkchkBlueCheckBoxListchklchklFavColorsCompareValidatorvalcvalcValidAgeCustomValidatorvalxvalxDBCheckCrystalReportViewerrpvwDataGriddgdgTitlesDataListdlstdlstTitlesDropDownListddlddlCountriesHyperLinklnklnkDetails

ImageimgimgAuntBettyImageButtonibtnibtnSubmitLabellbllblResultsLinkButtonlbtnlbtnSubmitListBoxlstlstCountriesPanelpnlpnlForm2PlaceholderplhplhFormContentsRadioButtonrbrbFemaleRadioButtonListrblrblGenderRangeValidatorvalgvalgAgeRegularExpressionvalevaleEmail_ValidatorRepeaterrptrptQueryResultsRequiredFieldValidatorvalrvalrFirstNameTabletbltblCountryCodesTableCelltblctblcGermanyTableRowtblrtblrCountryTextBoxtxttxtFirstNameTreeViewtvwValidationSummaryvalsvalsFormErrorsXmlControlxmlcxmlcTransformResults3、ADO.NET控件命名規(guī)范類型前綴示例ConnectionconconNorthwindCommandcmdcmdReturnProductsParameterparmparmProductIDDataAdapterdaddadProductsDataReaderdtrdtrProductsDataSetdsdsNorthWindDataTabledtdtProductDataRowdrdrRow98DataColumndcoldcolProductIDDataRelationdreldrelMasterDetailDataViewdvwdvwFilteredProducts4、Html控件命名規(guī)范類型前綴示例HtmlAnchorhah

HtmButtonhbtnHtmFormhfrmHtmGenericControlhgcHtmImagehimgHtmInputButton（按鈕）hbtnHtmInputButton（重置）hrbtnHtmInputButton（提交）hsbtnHtmInputCheckBoxhcbHtmInputFilehfileHtmInputHiddenhhidHtmInputImagehiimgHtmInputRadioButtonhrbHtmInputText（密碼）hpwdHtmInputText（文本）htxtHtmSelecthsltHtmTablehtabHtmTableCellhtcHtmTableRowhtrHtmTextAreahtxta5、客戶端 JavaScript規(guī)范類型前綴示例整型變量int□□□□□lng□□□□□flt□□□□□dbl□□□□□□obj□□□□□strDat