1

即使不是所有的标签和评论都是正确的，是否可以生成 Qooxdoo API？

当我尝试时generate.py api，我遇到了很多错误。生成器可以忽略这些错误吗？

== 编辑

我将Qooxdoo 文档标准与我们的编码/spket 标准文档进行了比较。

Qooxdoo 想要的参数文档格式如下

@param [name] {[type]} [description]

Spket 有 Style

@param {[type]} [name] [description]

即使名称和描述之间有换行符。所以会出现错误。

为什么无法忽略那些缺少的参数名错误，甚至无法提供其他格式？

== 结束编辑

谢谢，埃尔

4

2 回答 2

1

当然，即使您没有记录任何内容，API 的生成也应该始终有效。所以错误大多来自其他一些情况。也许您应该发布生成器生成的错误消息，以便我们可以消除该错误。

问候，马丁

于 2010-08-18T11:08:43.107 回答
1

仅当您通过 @param 定义出错时，生成器才会停止。但仅当您未定义参数名称时：

/**
 * bla bla
 *
 * @param {String} bla bla
 */
test : function(test) { ... }

在这种情况下，缺少“test”的名称，生成器会停止并出现如下错误：

>>> Generating API data...
  - Loading class docs... 10% 20% 30% 40% 50% 60% 70% 80% 90% 100%
    - Failed: Missing name of parameter., Line: 78, Column: 12
!!! Error in API data of class: testapi.Application
!!! Found erroneous API information. Please see above. Stopping!

只需添加缺少的名称（错误显示文件中的行）：

/**
 * bla bla
 *
 * @param test {String} bla bla
 */
test : function(test) { ... }

现在生成器不会停止，如果您犯了其他错误，例如缺少 @return 定义，生成器会创建 API 查看器，当您打开 API 查看器时您会看到问题。

于 2010-08-19T08:56:29.510 回答