OT1-A-0001-WW-004-V1.0-USI MES AP C# Template開發規範文档-2022.03.30.pptx

MESAP

C#Template開發規範EevayIT/SDDJune3,2024

C#程式撰寫規範

2

Class內成員命名規則(1/2)private或public變數使用上前面都加thisthis._userName=userName;private變數都是以”_”+小寫開頭privateString_userName;public,static變數都是以大寫開頭的PascalpublicStringUserName{get;set;}const變數都是全大寫privateconstStringCODE_SOFT=CodeSoft;Local變數是小寫開頭的camelCaseconst和static變數使用上前面都是用classnameCodeSoftPrinter.CODE_SOFT;3

Class內成員命名規則(2/2)4

Class內Function命名規則與註釋(1/3)Function開頭第一個字都大寫盡可能地為你寫的Function寫下summary註解在Function上方輸入三個反斜線按Enter，visualstudio便會幫你長出規格5

Class內Function命名規則與註釋(2/3)6

Class內Function命名規則與註釋(3/3)Function有做summary註解，別人在呼叫時，就可以出現提示幫助理解功能7

Form內的元件命名對於有作用的元件名稱，都以小寫ux為前綴字眼ux=UserExperience(使用者經驗)8

新增class檔(1/2)新增SubForm命名請大寫開頭，結尾帶Form字眼，並放置SubFrom資料夾下E.g.SoundSettiongForm請不要跟著舊程式用一樣簡寫名稱，請將完整名稱寫出來好辨別SSNLengthForm…..(O)SSNLengthDlg1……(X)9

新增class檔(2/2)新增功能型Class的時候，一樣是大寫開頭，並放置SfisUtility資料夾E.g.CommonFunc10

程式碼擺放歸類-利用#region(1/4)純功能性Class基本程式碼結構11

程式碼擺放歸類-利用#region(2/4)FormClass基本程式碼結構12

程式碼擺放歸類-利用#region(3/4)若一個Function裡的邏輯動作很多，可利用region來分段說明13

程式碼擺放歸類-利用#region(4/4)可對Function進行更詳細的分類14

C#撰寫習慣(1/5)用this關鍵字代表當前實例用this.來調用當前實例的成員,變量,屬性,字段15

C#撰寫習慣-TryCatch(2/5)用tryCatch預防Exception發生每個function請一定要先使用try…Catch包住，不想看見程式意外關閉，無法知道錯在哪一行16

C#撰寫習慣-TryCatch(3/5)用tryCatch時，於最外側的Function，通常是ux開頭的元件EventFunction，要抓到Exception時寫下log17

C#撰寫習慣-TryCatch(4/5)其餘非最外側Function(非ux開頭)的subFunction就throwex即可，或者因為邏輯流程上需求returnfalse18

C#撰寫習慣(5/5)盡可能的為你的操作動作留下log紀錄Trycatch的errorlog希望也可以明確標示是哪個function的問題19

C#善用PropertyClass的Public成員請用Property寫法，不要直接宣告Public的變數publicStringTitle{get{returnthis._title;}}…..(O)publicStringTittle;…….……(X)好處權限控管資料綁定行為控制參考網站.tw/yc421206/archive/2011/06/06/27233.aspx20

C#using的使用有實作Dispose的物件都用using包E.g.呼叫SubFrom,建立DB連線....Using會在結束後，自動呼叫Dispose，等待GC回收記憶體21

仿效MES0000-FormTemplateFormTemplate已經有寫好DB連線執行SQL的方式，也有登入的功能範例等等，請在翻寫相關功能的時候都先複製Template去移植功能22

程式Table設定C_MES_AP_CONFIG_T有CLEAR_POOL_AFTER_X_SEC設定用於計數DB連線閒