让 NDoc 1.3 支持.NET 2.0 程序集,泛型输出和 Visual studio 2005 解决方案导入

最近要做一份sdk手册,就找到NDOC ,到官方下载了最新的版本 NDoc 1.3 英文版安装包,结果发现支持.NET 1.1的程序集的文档生成,因为内部使用了反射机制,那么要支持.NET 2.0 的程序集很简单;

办法有两个:
1、用VS2005 重新编译一下
2、编写一个NDocGui.exe.config,直接指定版本,内容如下

<configuration>
   
<startup>
      
<supportedRuntime version="v2.0.50727" />
   
</startup>
</configuration>

ok,经过上面的任何一步之后,就已经支持了.NET 2.0 环境了,但是他是全英文的,生成出来的文档不能达到要求;经过寻找,确定了国内的一个汉化版本,作者是“破宝(percyboy)”,看了测试的效果非常不错,感谢。

http://www.percyboy.com/w/ndoc/ 下最新的汉化版本和它的汉化版本的原始代码;经过比较,它也是基于.NET 1.1 环境,仅支持Visual Studio.net 2003 解决方案导入,那么它仅仅只是汉化了资源,代码部分应该和英文版本的差不多;

首先解决.NET 2.0 环境问题,打开visual studio 2005编译一次,即可。

Visual studio 2005 解决方案导入,核心的代码是NDoc里的VisualStudio工程,下载这个代码包,覆盖原始工程,重新编译即可。解决.NET 2.0 的程序集内有泛型的类或方法,将产生异常,具体错误是 (Type == null) 而访问.FullName 属性,那么将Core工程的ReflectionEngine.cs 类打开,增加该函数:

private static string GetFullName(Type type)
{
    
string name;
    
if (type.FullName == null)
    
{
        Type result 
= null;
        
if (type.IsGenericType && !type.IsGenericTypeDefinition)
        
{
            result 
= type.GetGenericTypeDefinition();
        }

        
else if (type.IsGenericParameter || type.ContainsGenericParameters)
        
{
            
return type.Name;
        }

        
if (result == null || result.FullName == null)
        
{
            
throw new ArgumentException("Incomplete type: " + (result != null ? result : type), "type");
        }

        name 
= result.FullName;
    }

    
else
    
{
        name 
= type.FullName;
    }

    
return name;
}


并且将内部那些以 private string Get....(Type type) 命名的函数内部的 type.FullName 都修改为该函数的调用形式即可。
如:

private string GetMemberName(Type type)
{
    
//原始的为 return "T:" + type.FullName.Replace('+','.');
    return "T:" + GetFullName(type).Replace('+''.');
}

如果觉得麻烦也没关系,直接下这个代码覆盖;

/Files/Chinasf/ReflectionEngine.rar

以上修改都是基于中文汉化版本修改的,请自行测试。另外再次感谢汉化工作者所做的辛勤劳动,让我工作起来得心应手!

9:58 2006-6-8

posted @ 2006-06-08 10:06  suifei  阅读(7773)  评论(17编辑  收藏  举报