Visual Studio 将鼠标悬停在变量和函数上提示

5ktev3wc  于 2023-02-24  发布在  其他
关注(0)|答案(1)|浏览(820)

我知道我需要添加///<summary>才能在函数和变量上有鼠标悬停提示,但有没有办法只在//上实现这一点?
在预先构建的默认函数中,我总是看到这样的摘要

//
// Summary:
//     Tip.

当我把鼠标移到那个函数上时,它工作正常,但是当我把鼠标移到我自己的变量或函数上时,就不会这样了。
有没有办法让这样的东西工作?

// Tip for information
string information;

information = "Speed of light is 300000 Km per Second";

当我浏览信息时,它应该显示 * 信息提示 *。

uklbhaso

uklbhaso1#

这是一种XML文档注解,具体地说,它被称为“三斜杠注解”
就像它的名字一样,定义完属性或方法后,只需要在定义前一行按三下斜杠键,VS就会自动为你填充内容(当然,你也可以全部自己写)。

三斜杠注解通常用于描述成员(如方法、属性、类等)的角色和用法。

这里有一个例子,我想它会对你有所帮助:

using System;

namespace xxx
{
    internal class Program
    {
        static void Main(string[] args)
        {
            var bowman = new Person { Name = "Bowman", Age = 25, Information = "xxx" };
            var result = bowman.SayHello();
            Console.WriteLine(result);
        }

    }
    public class Person
    {
        /// <summary>
        /// The name of the person.
        /// </summary>
        public string Name { get; set; }
        /// <summary>
        /// The age of the person.
        /// </summary>
        public int Age { get; set; }

        /// <summary>
        /// Speed of light is 300000 Km per Second
        /// </summary>
        public string Information { get; set; }
        /// <summary>
        /// This method is to say hello.
        /// </summary>
        /// <returns></returns>
        public string SayHello() {
            return this.Name + " Say Hello to you.";
        }
        
    }
}

以及性能:

例子是我随便写的,主要是给予大家示范一下,公文在这里:
XML documention comments

相关问题