什么是代码文档资料(NDoc)? - 洛阳知道 免费ASP.NET/Java程序员培训

什么是代码文档资料(NDoc)?

发布时间: 2009-04-25 21:04:26  约 685 人浏览
1.什么是代码文档资料(NDoc)?
简单说,就是对代码的说明文档 C#.NET 编译生成的程序集和对应的 /doc XML 文档,自动转换成如 .NET Framework SDK 类库文档或者 MSDN Library 在线 .NET 类库文档形式的代码文档。

2.怎么在VS.NET中自动生成代码文档资料?
只要保证你的注释符合规则,然后单击“工具”中的“生成注释Web页”就可以自动生成代码文档资料了,其存放路径为你的项目所在的目录,名字为“CodeCommentReport”文件夹里面就可以看到所有的代码文档资料了.

3.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 可以将 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

NDoc 1.3.1 中文版发布

NDoc
主站点:NDoc 英文版
NDoc
中文站点:NDoc中文版

热门文章

友情链接: 围棋教学网 我的博客 大气象学习乐园 博客园 会计培训 洛阳知道论坛 梦想开始的地方 python课堂 铁闸网 GHS可用IP 我就要嗨吧 DJ摇摇网
给我留言
[关闭]