SandCastle:为C#类名生成链接

Question

当我在我的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#项目生成文档？

谢谢。

Answer 1

有没有办法在没有特殊标记的情况下为类和方法生成链接？

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

如何为C#项目生成文档？

我们使用Sandcastle和Sandcastle Helpfile Builder (SHFB)。此外，我们还使用GhostDoc和ReSharper来帮助编写和(即时)验证XML注释，例如，如果引用的类型、方法或其他内容确实存在。

我认为你也可以在你的C#代码中使用Doxygen，因此Doxygen风格的注释，但就我个人而言，我从来没有尝试过。你得检查一下氧气瓶website。但是你可能会错过其他工具提供的基于XML文档的特性(比如ReSharper's quick documentation)，或者最重要的是，智能感知的帮助/描述文本。