Question

我正在尝试为我开发的函数添加描述 - 当其他开发人员使用我的单元或用户使用API / COM来连接和使用我们的软件时，我希望此描述显示在代码洞察中。目前他们所看到的只是函数名称和返回类型，但他们不知道函数究竟做了什么。

在C＃中使用XML标记。

Answer 1

Marco Cantu a great blog post介绍了如何使用Visual Studio用于自定义HelpInsight的相同XML标记系统。

Answer 2

我不确定你需要的是什么，但是：

    /// <summary>
    /// 
    /// </summary>
    /// <param name="par1"></param>
    /// <param name="bla"></param>
    /// <param name="foo"></param>
    /// <returns></returns>

把它放在一个函数声明上面（只需键入/字符三次，visual studio就可以了。）总之，你必须把描述

Code Insight（智能感知）

2 个答案: