1

DocBook 标准是否包含任何与 JavaDoc @since 标记等效的元素？

我专门尝试在“refentry”元素中执行此操作，但似乎没有什么合适的。

4

2 回答 2

1

我很确定没有 Javadoc@since标记的语义等价物。DocBook<refentry>以手册页为模型，在 groff（man 宏）中也没有为此目的的特定标记，AFAIK。例如，mmap手册页有几个“since”注释，它们简单地包含在 groff 源代码中，如下所示：

.BR MAP_32BIT " (since Linux 2.4.20, 2.6)"

dbdoclet是将 Javadoc 转换为 DocBook XML 的工具。@since对于在其顶级文档注释中有标签的类，它会输出如下标记：

<variablelist>
    <varlistentry>
      <term><emphasis>Since</emphasis></term>
      <listitem>
        <para><simplelist type="inline"><member>January 8, 2014</member></simplelist></para>
      </listitem>
    </varlistentry>
</variablelist>

这没有什么“错误”，但它相当冗长。

我建议保持简单。只需将“since”信息添加到任何看起来合适的标记容器中。例如：

  • refsection 的标题：

    <refsection>
   <title>TITLE HERE (since release X.Y.Z)</title>
    ...
</refsection>

  • 一个段落（可能带有一个role属性）：

    <para role="since">Since release X.Y.Z</para>
于 2014-04-11T15:34:37.063 回答
0

也许带有子标签revision的标签revhistory可以用于它。

下面是一个小例子来捕捉这个想法： 

<section  title="Section with history information">
  <revhistory>
    <revision>
      <revnumber>0.9</revnumber>
      <date>1996-12-11</date>
    </revision>
  </revhistory>

  <para>
    <revhistory>
      <revision>
        <revnumber>0.8</revnumber>
        <date>1996-11-11</date>
      </revision>
    </revhistory>
    This paragraph has it's own revision history.
  </para>
</section>
于 2014-01-28T12:54:48.567 回答