c# - 在asp.net中调用函数时如何显示输入值的描述？

Question

我想在 asp.net 中添加我们在函数中输入的参数/值的描述。

这样当我们调用该函数时，它将显示要输入的值的描述。

代码：

public static void DoingSplit(string name, int id)
{
  // some code
}

protected void Page_Load(object sender, EventArgs e)
{
  // some code
  DoingSplit(name,id);
}

当有人调用该函数时我想做

DoingSplit(

当他按下(键智能感知显示描述你必须传递的值类型。

在我的情况下，通常它只会显示string 。

我想在此添加更多描述。like :输入不带空格的字符串。

任何人都可以帮助我解决这个问题。

Answer 1

您可以通过在方法上方的行中键入 /// 来执行此操作。这将自动生成 XML 文档供您填写：方法描述、您使用的每个变量的描述以及（如果返回任何内容）方法返回的内容。

例子：

/// <summary>
/// checks if the given number is prime
/// </summary>
/// <param name="number">the number to be checked</param>
/// <returns>boolean that is true if the number given is prime</returns>
private bool CheckIsPrime(int number)
{
    //code
}