Question

我想在Sandcastle中添加一行生成的示例代码这就是我到目前为止所写的内容

/// <summary>
/// Represents the SQL Connection for interaction with the Database
/// </summary>
/// <example> Add these lines in the Web.config or App.config File. 
/// Value here should be the Active Database Context
/// <code>
/// <appSettings>
/// <add key= "DBName" value="ActiveDBContext"/>
/// </appSettings>
/// </code>
/// </example>
public class DataConnection : IDisposable
{
   // rest of the class here
}

但是在sandcastle生成的文档文件中，它显示如下

<appSettings><add key="DBName" value="ActiveDBContext" /></appSettings>

我希望它像这样显示

<appSettings>
   <add key= "DBName" value="AssetCaptureDB"/>
</appSettings>

我想这是因为＆lt; ＆安培; ＆GT;字符，如何在文档文件中添加换行符，其中包含这些字符。

Answer 1

尝试：

/// <code><![CDATA[<appSettings>
///    <add key= "DBName" value="AssetCaptureDB"/>
/// </appSettings>]]></code>

我没有尝试使用Sandcastle，但使用VSdocman（这是我们的产品）它运行良好。该评论是使用VSdocman的评论编辑器生成的。

在Sandcastle中添加Line生成的示例代码

1 个答案: