程序中中的注释，一般是有益处的，可以知晓程序的一些逻辑说明，或是参数解释。但是有些程序，因为注释太多，反而引起维护上的不方便，删掉了怕以后不能出现问题不好查找原因，不删除留在代码中，对程序的维护人员，是一种痛苦。
以下列举我可以理解的的原因，供分析参考。
1、方法调用移动到新的类型中，原方法仍然保留在原来的类型中
| //public void ExecuteSqlCommand(string sqlCommandText) //{ //this.ExecuteSqlCommand(sqlCommandText, CommandType.Text, null); //} ...... |
ExecuteSqlCommand方法已经被移植到新的辅助类型SqlHelper中，但是这里的还没有直接删除。保留的目的，有可能存在反射调用，在报错之后，看到这里的代码被注释后，再才会重新查找这片代码的新的归属。
2、删除不需要考虑的的条件或情况，因为怕考虑不充分而没有删除代码
static ClientProxyFactory() //if (Platform == CommunicationPlatform.Local) |
在上面的代码中，CommunicationPlatform为Local的情况被注释掉了，但是没有直接删除。被注释的代码的作用是添加程序集到_managerTypeAssemblies类型中。可能是的原因是，系统现在不再支持Local模式，而只支持.net Remoting模式，所以这段代码会被注释。
3、因为考虑不周全，导致代码中注释与功能并存。保留注释是为了出错的情况下，帮助分析代码
来看下面的二个公共方法的定义，一个是反射调用静态方法，另一个是反射调用静态属性的值。
/// <summary> //obj2 = Activator.CreateInstance(type, args); System.Reflection.MethodInfo method = typeName.GetMethod(methodName,new Type[]{ typeof(object)}); // object obj = Activator.CreateInstance(typeName, args); public static object GetStaticPropertyValue(Type type, string propertyName) |
从上面被注释的代码中可以看到，需要的代码与被注释的代码共同存在。可能因为参数或是条件的不同，被注释的代码可以运行，是正确的，但是当前情况下，没有被注释的代码才可以运行。公共框架的开发本身要考虑的条件很多，测试也要充分才能保证无错。从这里也可以看出，反射给代码重构带来障碍，因为不知道代码在哪里会被反射调用，所以代码只有等到运行出错之后才发现。
除非正常调用情况下无法实现，应该减少反射调用代码。或者对反射调用代码进行封装，所有的反射调用放在一个ReflectionHelper类型中，如果要查找问题，只需要在这个类型的相应方法中打断点即可。
4、异常处理机制的改变，导致代码中捕获异常的代码被注释
请看下面的二个方法，用于拷贝文件和拷贝目录
//bakup file public static void CopyDirectory(string oldDir, string newDir) |
这种依靠返回true/false的得知代码是否执行成功。我现在比较反感这样的代码。因为如果拷贝文件或拷贝目录出错，没有报错，异常在这里被捕获。而且第二个方法CopyDirectory中，抛出异常后会改变异常的堆栈信息，这样导致比较难发现错误。如果是WinForms程序，应该以下面的方式处理异常
| CustomExceptionHandler eh = new CustomExceptionHandler(); AppDomain.CurrentDomain.UnhandledException += new UnhandledExceptionEventHandler(CustomExceptionHandler.CurrentDomain_UnhandledException); Application.ThreadException += new ThreadExceptionEventHandler(eh.OnThreadException); |
在程序的入口处，设置UnhandledException 和ThreadException 的处理情况，程序中有发生异常后，流程会跳转到这里，作统一的处理。以我的实践，像下面这样的方法，不应该这样处理
| /// <summary> /// 复制文件，如果目标文件已经存在则覆盖掉 /// </summary> /// <param name="oldFile">源文件</param> /// <param name="newFile">目标文件</param> public static void CopyFile(string oldFile, string newFile) { try { File.Copy(oldFile, newFile, true); } catch (Exception exc) { throw new Exception(exc.ToString()); } } |
