Как я могу сделать справочный код в моей документации по С#?
Я делаю документацию по формату 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
Да, чувак, это именно то, что мне нужно! Спасибо!!
Ответы 2
Вы должны использовать элемент <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 следующим образом:
Вы можете использовать тег <see>. См. его документация. Например, поместите в раздел <remarks> функции Checking:
<see cref = "Calculate"/>
и вы получите ссылку на страницу документации функции Calculate. Обратите внимание, что теги документации работают только в комментариях XML-документации. Вы можете поместить их в комментарии в своем коде, но вы не получите ссылку.
Вы имеете в виду что-то вроде этого?
This uses the <see cref = "Test.Calculate"/> methodв резюме?