我想在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>
我猜这是由于<&>字符引起的,如何在这些字符所在的文档文件中添加换行符。
尝试:
/// <code><![CDATA[<appSettings>
/// <add key= "DBName" value="AssetCaptureDB"/>
/// </appSettings>]]></code>
我没有在Sandcastle上尝试过,但是在VSdocman(这是我们的产品)上运行良好。该注释是使用VSdocman的注释编辑器生成的。
本文收集自互联网,转载请注明来源。
如有侵权,请联系 [email protected] 删除。
我来说两句