javascript - 生成 qooxdoo api 并忽略错误

Question

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

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

==编辑

我比较了 Qooxdoo documentation standard使用我们的编码/spket 标准文档。

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

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

Spket 有风格

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

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

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

==结束编辑

谢谢， el

Answer 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 查看器时看到问题。