【问题标题】:Add type column to Sandcastle Property table将类型列添加到 Sandcastle 属性表
【发布时间】:2014-05-07 00:20:15
【问题描述】:

所以我正在使用 Sandcastle Help File Builder 生成一个文档网站。一切都很棒!但是,在查看类的页面时,我希望 Properties 表(当前具有图标、名称和描述列,见下文)包含属性类型列(int、bool、string等)。

我正在某处阅读有关用于模板的 xsl 文件,但老实说,试图找到我正在寻找的东西有点不知所措。

所以基本上,我想在上表中添加一列,列出类型(字符串、整数等)。那可能吗?谢谢!

【问题讨论】:

  • 可以在摘要注释中使用 标记手动在描述中包含类型。 msdn.microsoft.com/en-us/library/acd0tfbe.aspx
  • 你有没有想过这个问题。我来这里是为了发布同样的问题。
  • 不完全。我能想到的最好的方法是基于@Darragh 的建议。我会发布一个包含一些细节的答案。

标签: .net visual-studio xslt documentation sandcastle


【解决方案1】:

不幸的是,经过大量搜索后,我仍然无法找到完全按照我的意愿进行操作的方法(作为单独的专栏)。正如 Darraugh 指出的那样,最好的方法是将其手动包含在描述中。有两种方法可以做到这一点。使用<See> tag 或使用<seealso> tag

<see> 标签可以这样使用:

/// <summary>
/// Assessment ID to be copied
/// <see cref="System.Int32">System.Int32</see>
/// </summary>

并产生以下内容:

&lt;seealso&gt; 标签可以这样使用:

/// <summary>
/// Assessment ID to be copied
/// <seealso cref="System.Int32"/>
/// </summary>

并产生以下内容:

这有点多余,因为您必须进入属性才能看到它,它已经显示了属性类型。

希望当这个答案被实施到沙堡本身时,这个答案会在某个时候变得过时。但就目前而言,这可能会帮助其他人,因为它已经帮助了我。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2021-09-26
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2018-08-22
    • 1970-01-01
    相关资源
    最近更新 更多