相关疑难解决方法(0)

如何在C#.NET文档中添加换行符

这应该更容易...

我想在我的代码中为XML文档添加"编码"换行符

/// <summary>
/// Get a human-readable variant of the SQL WHERE statement of the search element. &lt;br/&gt;
/// Rather than return SQL, this method returns a string with icon-tokens, which 
/// could be used to represent the search in a condensed pictogram format.
/// </summary>
Run Code Online (Sandbox Code Playgroud)

如您所见,我找到了一些答案,证明添加了<和>括号.有趣的是,好的'ol <br />换行符不会在Intellisense弹出窗口中创建换行符.

我发现这很烦人......

有什么建议?

.net c# xml-documentation

180
推荐指数
5
解决办法
6万
查看次数

记录F#代码

在具有单个构造函数的C#类中,我可以添加类摘要XML文档和构造函数XML文档:

///<summary>
///This class will solve all your problems
///</summary>
public class Awesome
{
    /// <summary>
    /// Initializes a new instance of the <see cref="Awesome"/> class.
    /// </summary>
    /// <param name="sauce">The secret sauce.</param>       
    public Awesome(string sauce)
    {
        //...implementation elided for security purposes
    }
}
Run Code Online (Sandbox Code Playgroud)

如何使用等效的F#类进行相同的操作,以使生成的文档相同?

type Awesome(sauce: string) = 
    //...implementation elided for security purposes
Run Code Online (Sandbox Code Playgroud)

澄清:我知道标准的XML文档标签可以在F#中使用.我的问题是如何将它们添加到上面的代码片段,以便记录类型和构造函数.

f# xml-documentation

23
推荐指数
3
解决办法
2469
查看次数

Visual Studio 2017:&lt;list&gt; 在悬停时未正确显示(xml 文档)

如果您将鼠标悬停///<summary></summary>在 VS17 (15.6.2) 中具有xml 文档 ( ) 的某些内容(类、方法等)上,您会看到这个小弹出窗口,其中显示了正确格式化的注释。

我试图列出一个清单(从这里复制):

/// <summary>Here is an example of a bulleted list:
/// <list type="bullet">
/// <item>
/// <description>Item 1.</description>
/// </item>
/// <item>
/// <description>Item 2.</description>
/// </item>
/// </list>
/// </summary>
Run Code Online (Sandbox Code Playgroud)

但是弹出窗口只在一行中显示它:

Here is an example of a bulleted list: Item 1. Item 2.
Run Code Online (Sandbox Code Playgroud)

我也尝试添加<term>它(就像这里),但我得到的只是:

在此处输入图片说明

我也试过其他type的(也没有),但没有改变。这是一个错误吗?我如何解决它?

c# xml-comments visual-studio visual-studio-2017

5
推荐指数
1
解决办法
299
查看次数