在C#评论甲方式链接到一个类中的方法,尤其是特定的代码行(A way to link to a cl

2019-08-01 05:36发布

我想建立某种使用代码指向一个目标链接文档。 所述目标可以是一个Class或一个Method或特定的代码行。 ( 指向特定的代码行是最重要的
我想到了一个扩展VS2010或特定注释标记的。
有什么办法使这种链接?

Answer 1:

XML注释+沙塔可能是你所需要的。 您可以参考指定的类或方法使用

<see cref=".."/>

并使用参考参数

<paramref name=".."/>

然而,没有直接的方法来引用的某些代码行,但您可以通过引用某些#区域

<code source="$sourcefile$" region="$regionname$"/>

请参考: XML注释指南第20页。

请注意,您引用的代码将直接显示在的地方,而不是链接。 它不是完美的,但我希望它能帮助。



文章来源: A way to link to a class,a method, especially a specific code line in C# comment