1

当我在我的 C++ 项目中使用 doxygen 时,我简单地写道:

/**
* I can refer to SomeClass or even SomeClass::someMethod() without special markup.
*/

然后 doxygen 生成从“SomeClass”和“SomeClass::someMethod()”字符串到适当文档的链接。

现在我使用 C# 并希望使用 SandCastle 从 C# 代码生成文档。我意识到应该使用 xml 标签构建链接:

/// <see cref="SomeClass"/> and <see cref="SomeClass.someMethod()"/>

我认为它非常繁琐且不可读。

有什么方法可以在没有特殊标记的情况下为类和方法生成链接?您如何为 C# 项目生成文档?

谢谢你。

4

1 回答 1

3

有什么方法可以在没有特殊标记的情况下为类和方法生成链接?

我不这么认为。实际上XML 文档(格式)不是沙堡的特性,而是 C# 编译器的特性。Sandcastle(和其他工具,如 NDoc)“简单地”构建在它之上。

您如何为 C# 项目生成文档?

我们正在使用SandcastleSandcastle Helpfile Builder (SHFB)。此外,我们正在使用GhostDoc和 ReSharper,它们有助于编写和(即时)验证 XML 注释,例如您引用的类型、方法或其他内容是否确实存在。

我认为你也可以在你的 C# 代码中使用 Doxygen 和 Doxygen 风格的注释,但我个人从未尝试过。您必须查看 Doxygen网站。但是您会错过其他工具提供的基于 XML 文档(如ReSharper 的快速文档)或最突出的是 Intellisense 的帮助/描述文本的功能。

于 2012-06-22T06:45:09.997 回答