Code Insight（智能感知）

我想为我开发的函数添加说明 - 当另一个开发人员使用我的单元或者当用户使用API/COM进行connet并使用我们的软件时，我希望将此说明显示在代码洞察中。目前他们看到的只有函数名称和返回类型，但他们不知道函数做了什么。Code Insight（智能感知）

在C＃中使用XML标签。

来源

2010-06-29 Anton

我不知道这是你需要什么，但：

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

将这个上面的函数声明（只需输入/字符三次，Visual Studio将做魔术）总之，你必须放置说明

来源

2010-06-29 13:52:43 astorcas

作为额外的好处，如果你安装了GExperts，你可以在你的函数声明之上键入“xdoc”，然后键入Alt + Maj + T，并且所有的标签都会自动添加。 – LeGEC 2010-06-30 07:32:27

Marco Cantu有a great blog post关于如何使用Visual Studio用于定制HelpInsight的相同系统的XML标记。

来源

2010-06-29 14:13:33

+1。不幸的是，我只能得到这个在平凡的（读：测试）情况下工作，而不是在我真实的代码上。 – 2010-06-29 15:05:36

Cosmin - 你可以扩展问题是什么？它应该适用于“真实代码”。 – 2010-06-29 16:13:21

@Nick：问题在于*洞察力一般都很差，在非平凡的代码库中会迅速降低。 – 2010-06-29 16:14:52

Code Insight（智能感知）

回答

相关问题