生成 qooxdoo api 并忽略错误

发布于 2024-09-14 19:45:14 字数 558 浏览 9 评论 0原文

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

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

== 编辑

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

Qooxdoo 希望参数文档的样式类似于

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

Spket 的样式，

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

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

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

==结束编辑

谢谢，埃尔

原文

is it possible to generate a Qooxdoo API even if not all tags and comments are correct?

When i tried generate.py api i got a lot of errors. Can the generator ignore these errors?

== edit

I compared the Qooxdoo documentation standard with our coding / spket standard docs.

Qooxdoo wants the documentation of parameters styled like

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

and Spket has the Style

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

even with line breaks between the name and the description. So the errors occour.

Why is there no possibility to ignore those missing parametername errors or even provide an other format?

== end edit

Thanks,
el

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

双手揣兜 2024-09-21 19:45:14

仅当您通过@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 查看器时您将看到该问题。

the generator only stops if you have done an error by the @param definition. But only if you do not define the parameter name:

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

In this case the name for "test" is missing, the generator stops with an error like:

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

Just add the missing name (the error shows you the line in the file):

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

Now the generator doesn't stop, if you have done an other mistake, like a @return definition is missing, the generator creates the API Viewer and you will see the issue when you open the API Viewer.

回复收藏 0 原文