标签: xml-comments

当折叠方法等的 XML 注释时。过去是隐藏摘要。正如我希望的那样。然后在 VS2015 中他们打破了这一点。我问了一个关于 VS2015 的类似问题，并在这里得到了一个很好的解决方法- 使用<para>.

直到现在，该解决方法在 VS2017 中仍然有效。现在我更新到版本 15.5.1 并且解决方法被破坏了，（为什么？？...）并且我找不到改变它的设置。

某处有吗？

我试图在 XML 文档注释中使用不同颜色的文本，如下图所示，“true”、“false”和“Window”一词的颜色为蓝色和绿色。

我尝试反编译包含这些内容的代码，但 xml 文档不同，并且 Microsoft 文档中也没有提及这种颜色。

我有一个使用xml文档的VS2008解决方案,我们在发布模式时启用了错误警告(一个很好的功能恕我直言); 然而,这导致了"缺少xml注释"的长列表,例如(自描述)枚举的每个元素.

有没有人知道关闭xml注释的请求的属性或类似内容？理想情况下,对于某些分隔区域,不只是一行(否则我可以在每个项目之前放置空标签,有点击败目的......)

谢谢!

我的同事很少(如果曾经)在使用我们的软件时使用XML注释(我不能说我没有更好).我最近看到了使用它们的好处,但如果他们记录的代码写得清楚(表达/描述变量/函数名称,一些内联评论),它们真的值得吗？

谢谢!

因此,您知道如何定义方法注释,例如

    /// <summary>
    /// Finds the site and information by site ID.
    /// </summary>
    /// <param name="siteID">The site ID.</param>
    /// <param name="customerLink">The customer link.</param>
    /// <returns></returns>
    public static Site FindSiteAndInformationBySiteID(int siteID, int customerLink)

有没有办法可以在代码中检索它.通过这个我不是说解析.cs文件,但实际上得到它,所以我可以使用它.就像是

<method>.XMLComment

提前致谢!

我从几个地方读到并了解到C#XML注释中没有作者标签.但我敢肯定,遇到这种情况我们必须用一些方法告诉别人某个班级是由谁和谁编写的.

对于我自己,我正在与一些人一起开展一个项目,有时候知道谁写了一个班级,最后修改日期等等.

在Java中,有一个@author,@modified等PARAMS征求意见,将产生的文档.我是C#的新手.由于XML注释中没有作者标记,因此当C#开发人员想要表明某个类是由他们编写时,会使用什么约定？

我的EDMX文件存在以下问题.

在其中我已经为属性和实体编写了一些文档,但是我的EF 5的t4模板并没有生成这些值.

我想要的结果应该是

public class Person
{
    /// <summary>
    /// Hello World Summary!!
    /// </summary>
    /// <remarks>
    /// Hello World Remarks!!
    /// </remarks>
    public string Name { get; set; }
}

但我只能得到

public class Person
{
    public string Name { get; set; }
}

如果不是这样,我为什么还能在edmx文件中设置文档属性.

如何在Visual Studio 2010中为C++方法ala C#和VB启用/实现XML注释？默认情况下,此功能似乎未启用/可用.

针对最初管理的C++项目.

在C#xml注释中,下面的标签有什么区别？

1. <c> 
2. <code>

我有以下代码块.

    /// <summary>
    /// AMethod produces this XML:
    /// <A><B></B></A>
    /// </summary>
    public void AMethod()
    {
    }

当我这样做时,如果我将鼠标悬停在AMethod上,IntelliSense就不会打印XML.如何让它打印XML？

如何SOAP UI使用短键在编辑器中注释掉代码串？

我有SOAP UI 5.2.1.

在我的代码库中，我在基类中定义了一个方法，基类是继承的，但该方法尚未被覆盖。将来很可能会覆盖此方法以添加到基本实现中。

我的设置看起来有点像这样：

public abstract class BaseFoo
{
    public virtual void Bar()
    {
        //default implementation
    }
}

public class RealFoo : BaseFoo
{
    //extra code, does *NOT YET* override Bar but might in the future
}

public class DependentClass
{
    /// <summary>
    /// Uses <see cref="RealFoo.Bar"/> to do some magic
    /// </summary>
    public void SomeMethod()
    {

    }
}

由于将来很可能 Bar 将被覆盖，因此我想将来证明我的 xmldoc 和引用RealFoo.Bar而不是BaseFoo.Bar.

当我调用RealFoo.Bar()我的代码时，没有发生错误。当我在 cref 属性中这样做时，我收到以下警告：

警告 CS1574 XML 注释具有无法解析的 cref 属性“Bar”。

我在这里做错了什么还是这只是 cref 的限制？ …

在xml文档中的以下代码中,方法参数中的参数名称与xml文档中的参数名称不匹配.有没有办法自动更正xml文档签名或resharper中提供的任何功能来自动更正xml文档.

#region Get Images

/// <summary>
///  Get Images 
/// </summary>
/// <param name="par1"></param>
/// <param name="par2"></param>
/// <returns></returns>
public Collection<UserImage> GetImages()
{
    return GetImages("");
}

/// <summary>
///  Get Images 
/// </summary>
/// <param name="par1"></param>
/// <param name="par2"></param>
/// <returns></returns>
public Collection<UserImage> GetImages(string imageType)
{
    return GetImages(0, imageType);
}

/// <summary>
///  Get Images 
/// </summary>
/// <param name="par1"></param>
/// <param name="par2"></param>
/// <returns></returns>
public Collection<UserImage> GetImages(int imageId)
{
    return GetImages(imageId, "");
}

/// <summary>
///  Get Images 
/// …