У меня есть код, написанный на CoffeeScript, и я хочу оптимизировать сгенерированный JavaScript с помощью Google Closure Compiler, поэтому эти файлы необходимо документировать с помощью JSDoc.
Мой вопрос: как я могу документировать файлы *.coffee для создания javascript, содержащего рабочий JSDoc для компилятора закрытия?
Еще один вопрос: есть ли способ сохранить однострочный комментарий в *.coffee?
Я бы посоветовал против этого. JSDocing всего вашего кода — это трудоемкий процесс, который, скорее всего, не принесет никакой пользы от Closure Compiler. Кроме самого Google этим практически никто не занимается. Сторонники CoffeeScript/JavaScript обычно предпочитают легкие инструменты документации, такие как docco.
Кроме того, несмотря на то, что за Closure Compiler стоит торговая марка Google, UglifyJS оказался более эффективной минификацией. инструмент во многих случаях. (jQuery недавно перешел на него.)
Еще один вопрос: есть ли способ сохранить однострочный комментарий в *.coffee?
Да:
### foo ###
or
`// foo`
// foo добавит ; в конце строки, есть ли способ удалить его?
- person aztack; 24.10.2011
### define function variable before block to avoid code being appended to closing part of JSDoc comment ###
cube = null
###*
* Function to calculate cube of input
* @param {number} Number to operate on
* @return {number} Cube of input
###
cube = (x) -> x*x*x
coffee -cpb src.coffee// Generated by CoffeeScript 1.6.3
/* define function variable before block to avoid code being appended to closing part of JSDoc comment*/
var cube;
cube = null;
/**
* Function to calculate cube of input
* @param {number} Number to operate on
* @return {number} Cube of input
*/
cube = function(x) {
return x * x * x;
};
Как подробно описано в другом ответе, у CoffeeScript 1.7.1 есть лучший метод для решения этой проблемы.
var cube перед определением функции, что запрещает JSDoc 3.2.0 генерировать документацию для функции.
- person rvernica; 17.07.2013
Поскольку я не могу напрямую ответить Билли выше, кажется, что CoffeeScript 1.7.1 лучше поддерживает это:
###*
# Sets the language and redraws the UI.
# @param {object} data Object with `language` property
# @param {string} data.language Language code
###
handleLanguageSet: (data) ->
выходы
/**
* Sets the language and redraws the UI.
* @param {object} data Object with `language` property
* @param {string} data.language Language code
*/
handleLanguageSet: function(data) {}
Вам придется экспериментировать (много), но ### комментарии вам в помощь.
Компилятор coffee-script сохранит комментарии, использующие форму ### (документы здесь).
Я попытался создать действительно простой фрагмент JsDoc для функции, используя функцию «попробовать coffeescript» на сайте:
###* Doc for this function.###
foo = -> 'bar'
Это дало:
/** Doc for this function.
*/
var foo;
foo = function() {
return 'bar';
};
Я не эксперт в JsDoc, но я предполагаю, что оператор var foo; над функцией создаст проблему. Если вы уже объявили foo раньше, может быть..
Было бы неплохо услышать, как дела.
class есть проблема
###* this is a class ###
class hello
v: 4
дает это
// Generated by CoffeeScript 2.0.0-beta5
/** this is a class */
var hello;
hello = (function() {
class hello {};
hello.prototype.v = 4;
return hello;
})();
и это недействительно в JSDoc
