标签: xml-comments

在Visual Studio(2012+)中,我想要一个从代码注释到TFS工作项的可点击引用.有没有一种简单的方法可以做到这一点,这也可能来自函数体内的注释(不是函数的摘要)？

所以我想要这样的东西:

/// <summary>
/// Example of a summary
/// </summary>
static void Main()
{
    int dummy = 1; //Should be 1 according to @Task1234 <- should be a hyperlink
}

而不是这样的事情:

/// <summary>
/// Example of a summary, see <a href="http://mytfsserver:8080//tfs/myCollection/Branch/_workItems#id=1234"> Task 1234 </a>.
/// </summary>
static void Main()
{
}

一些标签阅读材料: 文档注释的推荐标签(C#编程指南)

我知道remarks标签用于提供有关该类的其他信息,但在悬停/调用该类时它不会显示在intellisense中.我想知道它到底有用吗？

标题基本概括了所有内容.我在哪里应用我的XML注释？我应该在界面中添加更通用的XML注释,并在实现类中添加更具描述性的注释吗？像这样:

public interface IObjectRepository
{
    /// <summary>
    ///    Returns an object from the respository that contains the specified ID.
    /// </summary>
    Object GetObject(int Id);
}

public ObjectRepository : IObjectRepository
{
    /// <summary>
    ///    Retrieves an object from the database that contains the specified ID.
    /// </summary>
    public Object GetObject(int Id)
    {
        Object myData = // Get from DB code.
        return myData;
    }
}

<param>为简单起见,我没有包括在内.

这是一个很好的评论做法还是有不同的方式？我是否只是跳过评论界面？任何帮助表示赞赏.

在输入代码时,我非常喜欢Visual Studio 2010(Professional)的intellisense功能,特别是我能够查找正在使用的类型的XML注释.(请参阅Microsoft的文档).这项工作到目前为止.但是,XML代码注释的备注部分没有显示出来.

我认为这是一个非常有用的功能,因为通常有用的信息无法从摘要中轻易猜到.(这就是为什么我们有一个备注部分,我猜)

如何在intellisense级别探索Visual Studio 2010(Professional)中的备注部分？(我使用DevXpress Coderush,如果这很重要,但我不这么认为).

所以我在我的代码中使用XML注释来帮助解释公共方法和公共成员,另一位开发人员提到我并不是所有的方法都有XML注释.我使用规则,如果是公共的或受保护的,添加XML注释,如果是私有的,则不要.

这听起来合乎逻辑,还是有理由将XML注释为私有方法？

难道我还是在XML注释失踪System.Linq在Visual Studio的2015年？因为我仍然可以在MSDN上找到它.但是在输入时,例如,这段代码:

var list = new List<string>();
list.Select(

IntelliSense不提供命名空间中任何类/方法/成员/扩展的注释/文档System.Linq:

这里是打(当预览Alt键 +)F12到去定义了一个随机的扩展方法Enumerable:
我想我也没注意到Visual Studio 2013中的文档.但我确实记得他们曾经在那里,也许是在Visual Studio 2012或之前？

编辑:我忘了提到我在Visual Studio 2015中安装了Resharper 10 Ultimate.我还在Visual Studio 2013中安装了Resharper 8和9.

我试图让VB.NET XML注释与IntelliSense一起工作,也许它不像我认为的那样工作.

    ''' <summary>
    ''' Gets or sets the Patient Code.
    ''' <list type="bullet">
    ''' <listheader><description>Validation:</description></listheader>
    ''' <item><description>Field Required</description></item>
    ''' <item><description>Field Max Length: 25</description></item>
    ''' </list>
    ''' </summary>
    ''' <value>The region reference key.</value>

当你输入一个函数时,这应该显示"获取或设置患者代码"然后在它下面,它应该显示一个带有"验证:"作为标题的项目符号项列表？

替代文字http://www.codejames.com/errored.jpg

也许我做错了,但它似乎没有正常工作.

在指定摘要标记注释时,是否有一种方法可以使用<param>标记来指出参数是可选的,即.客户端可以提供值或null,例如:<param name="Mime" optional="true">.

谷歌搜索未能为我提供一组属性或允许值的集合.

/// <summary>
/// Sets data associated with instance
/// </summary>
/// <param name="Key">The key defining the data</param>
/// <param name="Value">The data</param>
/// <param name="Mime">The mime type of the data (optional)</param>     <----- Mark as optional

谢谢

可能重复:
如何在xml文档中引用泛型类和方法

我一直在使用see cref标签,它工作得很好,但现在我需要在see cref中包含一个string []的通用列表,但是文档没有正确呈现.

    /// <returns>A <see cref="List<string[]>" /> that .......

我认为它与<和>有关,也许[]

这是允许的,有解决方法吗？

我目前正在记录我的 C# 代码，并发现包含一个直接显示应如何调用一段代码的代码块很有用。我使用<code>嵌入到摘要中的标签：

虽然这通常有效，但我想保留空白（换行符、缩进）。到目前为止我尝试了以下操作：

• 我将该xml:space="preserve"属性应用于<code>标签，但这根本没有效果。
• 我曾经<br />指示单独的新行（这在 VS 2019 中有效），但我无法插入空格或制表符。我尝试使用 （用于空格）和	（用于选项卡），但弹出窗口不会显示这些。
• 我尝试使用一个CDATA部分，但之间的代码根本没有显示。

有什么方法可以保留 C# XML 注释的代码标签中的空白吗？提前谢谢你的帮助。