如何在VS或VS Code中为代码添加Tooltip描述？

不管是Visual Studio（VS）还是VS Code，都可以实现为代码添加Tooltip描述的功能，核心是通过对应语言的标准注释规范，编辑器会自动解析并在鼠标悬停时显示这些描述。具体实现方式如下：

Visual Studio（VS） #

• .NET语言（如C#）：使用XML注释格式，在代码元素上方添加以///开头的注释即可：

  /// <summary>
  /// 计算两个整数的和
  /// </summary>
  /// <param name="a">参与计算的第一个整数</param>
  /// <param name="b">参与计算的第二个整数</param>
  /// <returns>两个整数相加的结果</returns>
  public int Add(int a, int b)
  {
      return a + b;
  }
  

  鼠标悬停在Add方法上时，就会显示包含摘要、参数说明的Tooltip。
• C++：采用Doxygen风格的注释，用/** ... */包裹描述内容：

  /**
   * 计算矩形面积
   * @param width 矩形的宽度
   * @param height 矩形的高度
   * @return 矩形的面积值
   */
  double CalculateArea(double width, double height)
  {
      return width * height;
  }
  

VS Code #

VS Code依赖语言服务插件实现Tooltip解析，主流语言都支持通过标准注释生成Tooltip：

• JavaScript/TypeScript：使用JSDoc注释：

  /**
   * 计算两个数字的乘积
   * @param {number} x 第一个乘数
   * @param {number} y 第二个乘数
   * @returns {number} 两个数字相乘的结果
   */
  function multiply(x, y) {
      return x * y;
  }
  

• Python：使用Google、NumPy或reStructuredText风格的注释（需安装微软官方Python插件）：

  def subtract(a, b):
      """计算两个数字的差值
      
      Args:
          a (int | float): 被减数
          b (int | float): 减数
      
      Returns:
          int | float: 两个数字相减的结果
      """
      return a - b
  

• 其他语言（如Java、Go等）：遵循对应语言的官方注释规范，安装对应语言的官方插件后，编辑器会自动识别并显示Tooltip。

内容的提问来源于stack exchange，提问作者Ch.Muhammad.Bin.khalid