Создание API qooxdoo и игнорирование ошибок

можно ли сгенерировать Qooxdoo API, даже если не все теги и комментарии верны?

Когда я попробовал generate.py api, я получил много ошибок. Может ли генератор игнорировать эти ошибки?

== редактировать

Я сравнил стандарт документации Qooxdoo с нашими стандартными документами по кодированию / spket.

Qooxdoo хочет документировать параметры в стиле

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

и у Спкета есть стиль

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

даже с разрывами строк между названием и описанием. Так и возникают ошибки.

Почему нет возможности игнорировать эти отсутствующие ошибки имени параметра или даже указать другой формат?

== закончить редактирование

Спасибо, эль


javascript qooxdoo
person elCapitano    schedule 18.08.2010    source источник
comment
как я могу переформатировать определения @param? Я больше не могу использовать spket для форматирования, если формат неверен.   -  person elCapitano    schedule 19.08.2010

Ответы (2)


arrow_upward
1
arrow_downward

генератор останавливается только в том случае, если вы допустили ошибку в определении @param. Но только если вы не определяете имя параметра:

/**
 * bla bla
 *
 * @param {String} bla bla
 */
test : function(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.

person Christian Hagendorn    schedule 19.08.2010

arrow_upward
1
arrow_downward

Конечно, генерация API всегда должна работать, даже если у вас нет ни одной задокументированной вещи. Таким образом, ошибки чаще всего происходят из-за каких-то других обстоятельств. Возможно, вам следует опубликовать сообщение об ошибке, которое выдает генератор, чтобы мы могли устранить эту ошибку.

С уважением, Мартин

person Martin Wittemann    schedule 18.08.2010