Имам код, написан на CoffeeScript, и искам да оптимизирам генерирания JavaScript с Google Closure Compiler, така че тези файлове трябва да бъдат документирани с JSDoc.
Въпросът ми е как мога да документирам *.coffee файловете, за да генерирам javascript, съдържащ работещ JSDoc за компилатора за затваряне?
Още един въпрос: има ли начин да запазите коментар от един ред в *.coffee?
Не бих посъветвал това. JSDoc-ирането на целия ви код е трудоемък процес, който вероятно ще доведе до малка или никаква полза от Closure Compiler. Извън самия Google едва ли някой прави това. CoffeeScripters/JavaScripters обикновено предпочитат леки инструменти за документиране като 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
Тъй като не мога да отговоря директно на Billy по-горе, изглежда, че 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) {}
Ще трябва да експериментирате (много), но ### коментарите са ваш приятел.
Компилаторът на скрипт за кафе ще запази коментари, които използват формата ### (документи тук).
Опитах се да създам наистина прост JsDoc фрагмент за функция, използвайки функцията 'try 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
