代碼規范若干，代碼規范

代碼規范若干，代碼規范

1.       JS方法一定要有注釋

2.       JS功能要有注釋

如上圖所示，有注釋，幾個月後維護，只需1秒就能看懂它的功能，如果沒有注釋，你需要在代碼中查詢RESPONSIBLEDEPT或者查找數據庫設計文檔才能知道這段代碼的含義

3.       類一定要有注釋

4.       C#代碼要用#region包起來，#region之間要留一個且只留一個空行

5.       含義復雜不容易看懂的參數要寫注釋

6.       方法參數注釋，如果不寫請刪掉

7.       類的成員變量名以m_開頭

8.       DAL或Service變量名：m_類名

9.       DAL層代碼規范：向DAL類中添加方法，應根據方法的語義和方法的返回值決定方法寫在哪個DAL類中

 張三需要一個根據員工編號獲取員工信息的方法，他把這個方法寫在了ReportDAL類中，並起名GetEmployee(string empCode)，李四也需要一個根據員工編號獲取員工信息的方法，他去EmployeeDAL中去找這個方法，沒有找到，或者他壓根沒有去找，李四在ReportFlow中寫了一個GetEmployeeByCode(string empCode)方法，隨著開發的進行，代碼會變得相當混亂。王二需要修改BUG，發現需要修改GetEmployee(string empCode)方法，他修改了這個方法，但並沒有把BUG修改掉，因為他不知道在某個地方還有個GetEmployeeByCode(string empCode)需要修改，一個簡單的BUG就這樣變得復雜起來