从Parse.com Cloud Code生成JSDoc

Question

我正在使用Parse作为移动应用，我有一些Cloud Code功能，我想使用JSDoc生成文档。

如果我这样做：

/** This is a Cloud Code function */
Parse.Cloud.define('foo', function(request, response){
});

JSDoc不会生成文档。

但是，这样做有效：

/** This is a javascript function */
function foo() {
}

是否可以记录我的Cloud Code功能？

Answer 1

嗯，解决方案非常简单：

/** Document your Cloud Code function as a JS function */
var foo = function(request, response) {
}

//Then define it on Parse.Cloud
Parse.Cloud.define('foo', foo);

希望这有助于某人。

Answer 2

您还可以使用@method属性

来标记

/** 
 * Document your Cloud Code function as a JS function 
 * @method foo
 */
Parse.Cloud.define('foo', function(request, response) {
  //...
});