SandCastle:为C#类名生成链接

问题描述 投票:1回答:1

当我将doxygen用于我的C ++项目时,我只是写道:

/**
* 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#项目生成文档?

谢谢。

c# .net documentation-generation sandcastle
1个回答
3
投票

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

我不这么认为。实际上XML documentation (format)不是sandcastle的功能,而是C#编译器的功能。 Sandcastle(以及其他工具,如NDoc)“简单地”构建在它上面。

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

我们正在使用SandcastleSandcastle Helpfile Builder (SHFB)。我们还使用GhostDoc和ReSharper来帮助编写和(动态)验证XML注释,例如,如果类型,方法或您引用的实际存在。

我认为您也可以使用Doxygen,因此使用您的C#代码进行Doxygen样式注释,但我个人从未尝试过。你必须检查Doxygen website。但是你会错过其他工具提供的基于XML文档(如ReSharper's quick documentation)或最重要的帮助/ / Intellisense描述文本提供的功能。

© www.soinside.com 2019 - 2024. All rights reserved.