Question

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

我特意尝试在“refentry”元素中执行此操作，但似乎没有任何选择。

Answer 1

我非常确定Javadoc @since标签没有语义等价物。 DocBook的<refentry>是在手册页上建模的，并且在groff（man宏）中也没有针对此目的的特定标记，AFAIK。例如，mmap手册页有几个＆＃34;因为＆＃34;注释在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>

没有什么＆＃34;错误＆＃34;有了它，但它相当冗长。

我建议保持简单。只需添加＆＃34;自＆＃34;信息到任何看似合适的标记容器。例如：

重新标题：

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

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

<para role="since">Since release X.Y.Z</para>

Answer 2

也许可以使用带有子标记revhistory的标记revision。

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

<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>

@since的DocBook标签？

2 个答案: