Как я могу сделать код ссылки в моей документации C #?

Question

Я делаю документацию в формате HTML для своего кода C #, и я хотел бы знать, возможно ли сделать ссылку в моем собственном коде.

Например:

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? Я имею в виду, если я смотрю документацию метода 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>. См. документацию . Например, укажите в секции <remarks> функции Checking:

<see cref="Calculate"/>

, и вы получите ссылку на страницу документации по функции Calculate. Обратите внимание, что теги документации работают только в комментариях к документации XML. Вы можете поместить их в комментарии в своем коде, но не получите ссылку.