让代码 Readable, Testable and Traceable

• Readable
  可读性好, 包括: 命名规范, 注释详细
• Testable
  可以单独测试
• Traceable
  出问题后, 可以被追踪到, 需要做好: logging

====================================================

如何让程序模块Traceable, 让开发者或者维护者知道该模块在整个系统中的位置和作用 :

1. 该模块依赖其他模块? (编译期 运行期)
2. 有哪些模块依赖该模块? (编译期 运行期)

依赖包括:

1. 编程元素之间依赖
   编译期可以发现错误
   程序集 接口 类 结构 枚举 方法 属性 字段
   通过反射和反编译
2. 编程元素和资源元素之间依赖
   一般以字符串形式嵌在代码中 或者 配置文件中 编译期无法发现错误
   数据库连接字符串 SQL语句 存储过程名称 文件路径 webservice地址 网址
   通过文档记录(某个Assembly中XXX类的YYY方法调用了ZZZ数据库的PPP存储过程)
3. 数据库元素之间依赖
   表之间 视图和表 存储过程 函数
   通过sp_depends发现