| 事项 | 说明 |
|---|---|
特别长的类型名称 |
NDoc 为每一个主题自动在硬盘上创建一个 HTML 文件。目前,文件名是根据完全限定名生成的。如果某类型/成员的完全限定名 (命名空间 + 类型 + 成员名) 的总字符数超过 _MAX_FNAME (256 字符),NDoc 将无法创建这样的文件,因为操作系统不支持如此多字符的文件名。另外,文件所在完整路径的字符也不能超过 _MAX_PATH (260 字符)。 如果完全限定名的字符数在 200 字符左右,那么您可能需要将 OutputDirectory 配置为一个靠近根目录的位置,这样可以避免文件的完整路径超出 260 字符。 但还没有关于文件名超出 256 字符的解决方法。 在未来某版本的 NDoc 中,我们会尝试解决此问题。 |
大小写敏感问题 |
文件名不是大小写敏感的,因此当 MSDN 文档引擎或者 JavaDoc 文档引擎创建 HTML 文件时,如果某些类型或成员只是在大小写上不一样,就会出现问题。 请尝试避免出现这种情况。(例如:公共属性为 Thing,私有字段为 _thing, 避免出现Thing 和 thing 并行。当然,如果不输出私有字段,并行也没有问题。只是说准备输出的类型/成员不要出现这种情况。) 在未来某版本的 NDoc 中,我们会尝试解决此问题。 |
StrongNameIdentityPermissionAttribute |
标记有 StrongNameIdentityPermissionAttribute 属性的程序集,需要有特殊的密钥才能被读取。NDoc 尝试为这样的程序集生成代码文档时,会抛出异常。
您可以考虑使用“条件编译”(#if...)方式为 NDoc 准备没有添加该属性的编译版本。 |
Compact Framework 不兼容 |
为 .NET Compact Framework 编译的程序集,当添加到 NDoc 项目中时,NDoc GUI 程序可能抛出异常。尤其是当该程序集引用了 Microsoft.WindowsCE.Forms 或 SqlServerCe 时,更是如此。 还没有找到此问题的解决方法。 在未来某版本的 NDoc 中,我们会尝试解决此问题。 |
本地化 |
NDoc 当前不支持本地化的文档格式及 GUI 文本 在未来某版本的 NDoc 中,我们 *可能* 会尝试解决此问题。 |
NDoc development is hosted by
|
![]() |