OStack程序员社区-中国程序员成长平台

标题: c# - 带有 DoxyGen 的 Visual Studio 用于文档，还是应该使用其他东西？ [打印本页]

---

作者: 菜鸟教程小白    时间: 2022-8-20 17:47
标题: c# - 带有 DoxyGen 的 Visual Studio 用于文档，还是应该使用其他东西？

关闭。这个问题是opinion-based .它目前不接受答案。












想改善这个问题吗？更新问题，以便可以通过 editing this post 用事实和引文回答问题.

3年前关闭。




Improve this question




我们目前正在使用 DoxyGen 来记录用 C/C++、PHP 和 Java 编写的代码。为了拥有一致的环境，最好也将其用于 C# 文档。

然而我们想知道:

您是否看到使用 DoxyGen 以外的其他工具生成的文档布局或结构有什么优势？我们正在为具有 C# 和 .NET 平台经验的外部开发人员生成文档。也许他们习惯于某种文档格式？

DoxyGen 与 Visual Studio 的集成度如何？有没有什么东西可以从 IDE 内部一键生成文档？

其他一些文档系统是否与 Visual Studio 更加集成？

---

Best Answer-推荐答案

在 Visual Studio 中记录 C# 代码的默认方式是通过 XML documentation comments .在我看来，这是使用 C# 代码的最佳方式，因为对此的支持已经集成在 Visual Studio 中(注释标签自动完成、有关缺少或拼写错误的参数的警告，...)。要记录方法，只需在方法主体前键入三个斜杠 ( /// )，Visual Studio 将插入一个空注释模板供您填写，如下所示:

/// <summary>
/// 
/// </summary>
/// <param name="bar"></param>
private void Foo(int bar)
{
    // ...
}

您可以将 Visual Studio 配置为从所有注释生成一个 XML 文件，然后将其输入到文档生成器中，例如 Sandcastle .如果您想使用 Doxygen ，这没有问题，因为它支持解析 XML 注释。
总结:我建议在 C# 代码的特殊 Doxygen 注释上使用 XML 注释。这样你就有了所有的选择。您可以按照组织熟悉的标准 Doxygen 布局生成文档(因为 Doxygen 支持 XML 注释)，此外您还可以选择以 .NET 开发人员已知的格式生成文档(使用 SandcaSTLe 和 Sandcastle Help FileBuilder)。
啊，也试试GhostDoc ...

关于c# - 带有 DoxyGen 的 Visual Studio 用于文档，还是应该使用其他东西？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/2028264/

---

欢迎光临 OStack程序员社区-中国程序员成长平台 (https://ostack.cn/)

Powered by Discuz! X3.4