Question

即使并非所有标签和评论都正确，也可以生成Qooxdoo API吗？

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

==编辑

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

Qooxdoo希望参数的文档类似于

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

和Spket有风格

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

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

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

==结束编辑

谢谢， EL

Answer 1

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

问候，马丁

Answer 2

如果您通过@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 Viewer，当你打开API Viewer时你会看到问题。

生成qooxdoo api并忽略错误

2 个答案: