Question

我正在研究API文档的重新定位。我们正在使用带有restdoclet的maven。我们用于API描述的通用代码如下所示：

/**
 * <name>API name</name>
 * <description>API description</description>
 * <type>API type</type>
 * <versions>
 *  <version>
 *   <number>1</number>
 *   <response>{"success":true}</response>
 *  </version>
 * </versions>
 * 
 * @param request
 * @param version API version
 * @param param1 first parameter
 * @param param2 (optional) second parameter
 * @return
 */

自动生成javadoc。问题在于有时候＆lt;回应＆gt; （这基本上是api返回的内容）正确显示（颜色，缩进），在其他情况下它根本不显示。

旧文档有一些API有错误的响应，所以我认为这是造成它的原因。有些调用就像魅力一样，但是仍然有一些API没有得到正确的格式或者只是获得响应的一部分（在某些情况下会发生这种情况，并且当调用返回一个值数组时）。 / p>

令我困惑的是，我发现代码没有区别，但有些响应是正确构建的，有些则不是。我试图查看一些xsl配置文件（其中有其他标记的构建规则，例如＆lt; name＆gt;，＆lt; type＆gt;，＆lt; version＆gt;）。这就是我认为它应该处理＆lt;回复＆gt;：

<div class="{substring-after(../../../uri/uri, '/')}-response-{number}">
 <script type="text/javascript">
  jQuery(function($) {
   var json = <xsl:value-of select="response"/>;
   JSONFormatter.format(json, {
    'collapse': false,
    'appendTo': '.<xsl:value-of select="substring-after(../../../uri/uri,'/')"/>-response-<xsl:value-of select="number"/>',
    'list_id': 'json-<xsl:value-of select="substring-after(../../../uri/uri,'/')"/>-<xsl:value-of select="number"/>'
   });
  });
 </script>
</div>

因此它可能与JSONFormatter有关，但我无法理解它失败的地方，以及为什么只有一些。

有什么想法吗？

在maven项目中构建javadoc时返回语句无法正常工作（使用restdoclet）

0 个答案: