如何在C＃文档中进行参考代码？

Question

我正在为C＃代码编写HTML格式文档，我想知道是否有可能在自己的代码中进行引用。

例如：

public class Test{
public bool Calculate(int x){ //code }
}

public class Check{
void Checking(int y, int x, int z){
//code
bool aux = Test.Calcultate(x);
//code
}

当我做这样的文档时：

 /// <summary>
 /// 
 /// </summary>
 /// <param name=""></param>
 /// <returns></returns>

如何从“检查方法”到“计算”方法对文档进行引用？我的意思是，如果我正在查看Checking方法的文档，那么必须有一个指向Calculate的链接

Answer 1

您应该使用<see>元素，例如：

/// <summary>
/// This uses the <see cref="Test.Calculate"/> method
/// </summary>
/// <param name=""></param>
/// <returns></returns>
void Checking(int y, int x, int z)
{
    //code
    bool aux = Test.Calcultate(x);
    //code
}

这将在IntelliSense中显示如下：

Answer 2

您可以使用<see>标签。参见其documentation。例如，放入<remarks>函数的Checking部分：

<see cref="Calculate"/>

，您将获得指向Calculate函数的文档页面的链接。请注意，文档标记仅在xml文档注释中起作用。您可以将它们放在代码的注释中，但不会获得链接。