代码规范若干

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就这样变得复杂起来