c# 编程规范

1.避免使用任何硬编码,例如用户名,密码,连接等。应在Enum类或Constant类或静态变量中定义常量值。
2.在使用前,请务必检查是否为空。
3.如果不再使用,则关闭连接,尤其是发生异常时。最好使用using语句。
4.不要硬编码根据部署而变化的字符串。所有环境的配置都应该有其自己的文件夹,setup build事件将配置复制到根文件夹。
5.代码应组织成具有描述性名称的可折叠区域。
6.制表符大小和缩进大小应为2个空格。
7.尽可能/在任何地方写评论和文档。
8.对解决方案,项目,类等使用有意义的名称,该名称应基于实体的含义。
9.请勿使用缩写词,例外情况是使用众所周知的缩写词,该缩写词已被广泛接受,否则名称的长度将太长。
10.尽可能晚地声明和初始化变量,避免滥用变量。
11.避免捕获通用异常类型,捕获更具体的异常,或将通用异常作为catch块中的最后一条语句重新抛出。
12.不要通过捕获通用异常来吞并错误,如果不处理,也不要捕获。
13.如果适用,请始终将异常记录到数据库中。
14.将大方法分解为较小的方法,这些方法可读取和重用。一种方法只能做一件事情,只有一个责任。
15.不要注释掉代码。切勿签入已注释掉的代码。不要使用注释来跟踪要完成的工作。
16.将成员按定义明确的顺序放置。

原文地址:https://www.cnblogs.com/wangzhe66369/p/13724428.html