摘要:继上一篇文章谈到 NDoc for NUnit 的初步构想之后，继续构想...... 首先，给这个构想中的工具暂定个名字叫 NUnitDoc。这个工具的预定目标是，以 NDoc 的设计和部分代码为基础，综合 (1) 包含 NUnit 测试用例的程序集（*.dll/*.exe）文件；(2) 开启 C# 编译器 /doc 开关，输出的相应 XML 文档文件（*.xml）；(3) NUnit 执行的结果 XML 文件（*.xml） 这三种文件中的信息，合并并制作出漂亮的测试文档。(1) 和 (2) 同样是 NDoc 所需要的，(3) 是 NUnit 所生成的。 需要感谢 CavingDeep 网友和我探讨这个构想。他给我介绍了几款可以根据 NUnit 生成 HTML 报表的工具，但我看了一些它们的输出 Sample 之后，认为它们不是我想要的东西。它们都是只利用了 NUnit 输出的结果 XML 文件，因此制作的 HTML 报表中，只包含关于测试结果的信息，并不包括关于测试用例的文档信息。 下面，我来具体描述一下我的构想：首先，在 TestFixture 标记的类的相关方法（标记有 Test 的方法）的代码上方，为它们编写一些注释信息（就和为 NDoc 编写注释类似的方法），比如下面的代码：[TestFixture] public class TextUtilTest { private TextUtil util = null; /// <summary>用例开始前，初始化 <b>TextUtil</b> 的一个新实例。</summary> [Setup] public void Setup() { util = new TextUtil(); } /// <summary>此用例用于测试 <b>TextUtil</b> 类的 <b>IsValidEmailAddress</b> 成员。 </summary> /// <asserts> /// <assert>输入一个合法的 Email 地址，验证返回值是否为 <b>true</b>。</assert> /// <assert>输入不含有 '@' 符号的字符串，验证返回值是否为 false。</assert> /// <assert>输入以 '@' 符号开头的字符串，验证返回值是否为 false。</assert> /// <assert>输入以 '@' 符号结尾的字符串，验证返回值是否为 false。 </assert> /// <assert>输入一个只含有 '@' 符号的字符串，验证返回值是否为 false。</assert> /// <assert>输入一个 '@' 符号前面包含空格的字符串，验证返回值是否为 false。</assert> /// <assert>输入一个 '@' 符号前面包含空格的字符串，验证返回值是否为 false。</assert> /// <assert>输入一个......[阅读全文]

摘要:刚刚译了 NDoc，又一次深入学习了 Reflection 反射发出、XSLT 转换，还学习了很多关于 HTML Help 1、Microsoft Help 2 等帮助文件的制作细节。 手中的项目客户点名要求使用 NDoc (日语版) 和 NUnit。前者当然是为了最终有一个漂亮的类库文档。后者则是 TDD 开发的标志物。 我想，日本人对文档的重视程度是国内开发人员所难以想象的。以往的项目，并不采用 TDD 开发，所谓单元测试(Unit Test)，最主要也最耗时的工作就是在那里拼凑“测试文档”，用大量的文字、表格、屏幕截图等等，证明 coding 没问题、输出是正确的；而并非真正的按照单元测试的要求、分 class/function 执行测试。 而按照典型的 TDD 开发，如果再如此这般的折腾“测试文档”，那可就完蛋了，因为 TDD 是测试先行，反复的执行“回归测试”……但测试总得有文档，否则怎么证明你测试了？如果每次回归都要文档，那就有些惨了。另外客户也要求单元测试的文档包含在最终交付物中。 也是因为刚译完 NDoc 的缘故，所以第一个念头就是：是否有一款能够配合 NUnit 自动生成“测试文档”的小工具？ NDoc 现有的体系是：从程序集(*.dll/exe)及其相应的 XML 文档文件(*.xml) 开始，最终输出代码文档。而 NUnit 也可以将测试结果以 XML 文件保存下来。 如果混合一下，从程序集(*.dll/exe)及其相应的 XML 文档文件(*.xml)，再加上 NUnit 的测试结果 XML 文件，最终输出“测试文档”？ 哎，一个新的工具就是这么“诞生”(？)了。可以使用和参考大量 NDoc 的现有代码。不过 NDoc 现在是 GPL 协议授权，也就是这个衍生物也必须是 GPL 的了。这点有些不爽，说实话，我喜欢 BSD，不太喜欢 GPL。抽时间再想吧，要睡觉了~...[阅读全文]

摘要:2003 年底，我发布了一个 NDoc 1.2 中文版，受到了许多国内 .NET 开发者的欢迎。当时我还在大学读书，时间、精力都远比现在充裕。在 NDoc 开发组推出 1.3 版本时，我已经开始了我的第一份工作，一年多来，工作的繁忙让我没有充足的时间和精力跟进 1.3 版本的翻译和汉化。工作之余，也经常在网络中搜索，也看到了不少朋友在做关于 NDoc 1.3 汉化的一些工作（比如：keyboy 版本，灵感之源(unruledboy)版本，tashanzhishi版本 等）。但说实话，这些版本都不算完整，几乎无法用于较为正式的场合。 八月末，公司的项目告一段落，我得以休整。便又重新拣起这项工作。一直到这个国庆假期结束，我终于把 NDoc 1.3 完全翻译结束，现在公开出来，希望能给喜爱这款实用工具的国内 .NET 开发者一份惊喜！ 欢迎光临 NDoc 中文站点！ 另外，NDoc 1.2 中只有一个 HTML 页的帮助文档，此次 NDoc 1.3 中附带了五十多页的“用户指南”。延续 1.2 的传统，这份“用户指南”我也译了出来，希望能给那些英文不太好的开发者一些帮助。但愿您能用得上！ 我计划在“NDoc 资源”页中，添加一个中文 NDoc 资源列表。如果您有写的不错的 NDoc 介绍文章(中文)，不妨与我联系！ NDoc - .NET 代码文档生成器 NDoc 可以将 C#.NET 编译生成的程序集和对应的 /doc XML 文档，自动转换成如 .NET Framework SDK 类库文档或者 MSDN Library 在线 .NET 类库文档形式的代码文档，让您快速拥有专业级的类库API 文档。(VB.NET 通过第三方插件如 VBCommenter 的支持，也可以生成 XML 文档。) NDoc 代码文档的样式包括 HTML Help 1 (即 *.CHM 格式)，Microsoft Help 2 (即以形如 ms-help://... 的 URI 地址访问的文档)，以及 MSDN 在线网页样式的 .NET Framework 类库文档。 NDoc 为开放源代码项目，采用 GNU General Public Licence 授权协议（除非您的软件/项目也采用 GPL 协议开放源代码，否则您不能在您的软件/项目中使用 NDoc 源代码中的任何部分）。更多的授权问题，请参见 GNU FAQ。 感谢您使用我们的软件，也期待着您的参与（建议、BUG 反馈、代码贡献）！ 欢迎光临 NDoc 中文站点！  ...[阅读全文]