1

すべてのタグとコメントが正しくない場合でも、Qooxdoo APIを生成することは可能ですか？

試しgenerate.py apiたところ、たくさんのエラーが発生しました。ジェネレーターはこれらのエラーを無視できますか？

==編集

Qooxdooドキュメント標準をコーディング/spket標準ドキュメントと比較しました。

Qooxdooは、次のようなスタイルのパラメータのドキュメントを必要としています

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

そしてSpketはスタイルを持っています

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

名前と説明の間に改行があっても。したがって、エラーが発生します。

欠落しているparameternameエラーを無視したり、他の形式を提供したりする可能性がないのはなぜですか？

==編集を終了

ありがとう、エル

4

2 に答える 2

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 に答える
1

確かに、APIの生成は、文書化されているものが1つもない場合でも、常に機能するはずです。したがって、エラーのほとんどは他の状況から発生します。ジェネレーターが生成するエラーメッセージを投稿して、エラーを回避できるようにする必要があるかもしれません。

よろしく、マーティン

于 2010-08-18T11:08:43.107 に答える