c# - C# 文档工具，不仅可以从源代码生成文档

Question

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

我想做这样的事情:

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

Answer 1

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

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

不过，我实际上建议反对它，因为将源代码和文档放在一个地方可以更容易地遵守 DRY principle 。您不希望文档和源代码分开，并且您可以随时折叠注释(这样，当您编辑源代码时它们就不会显示)。然后您的文档也将受到源代码控制。