如何在我的 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>

如何从检查方法到计算方法对文档进行引用？我的意思是，如果我正在查看方法检查的文档，则必须有一个 link 来计算

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。例如，在 Checking 函数的 <remarks> 部分中输入：

<see cref="Calculate"/>

你会得到 link 到 Calculate 函数的文档页面。请注意，文档标签仅在 xml 文档注释中有效。您可以将它们放在代码的注释中，但您不会得到 link.

如何在我的 C# 文档中制作参考代码？

How I can do a reference code in my C# documentation?

c#

documentation