C#的文档工具,不仅可以从源代码生成文档

时间:2011-12-21 05:58:33

标签: c#

我不想在源代码中添加xml注释或任何内容。

我想做这样的事情:

  1. 点击添加类 - 类型名称
  2. 点击添加方法 - 输入名称
  3. 类型说明,导入图片等。

2 个答案:

答案 0 :(得分:2)

你可以这样做,你知道编译器支持C#中的XML注释,输出就是这个XML,它只是XML。

您可以使用反射为此构建一个简单的工具。了解有关反射和.NET类型系统的更多信息是一个很好的练习。

尽管如此,我实际上会反对它,因为在一个地方拥有源代码和文档可以更容易地遵守DRY principle。您不希望文档和源代码分散,您可以随时折叠注释(这样,在编辑源代码时它们不会显示)。然后,您的文档也将受到源代码管理。

答案 1 :(得分:1)

Sandcastle制作了很好的msdn,就像xml代码中的帮助文件一样。

Tutorial

<强>更新

我很抱歉我的误导性答案。您可以尝试Adobe Robocop。我们使用它来制作高质量的chm文件,即使是GIF动画。