从 Parse.com 云代码生成 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) {
  //...
});