parse-platform - 从 Parse.com 云代码生成 JSDocs

Question

我正在将 Parse 用于移动应用程序，我有一些云代码功能，我想使用 JSDoc 生成文档。

如果我这样做：

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

JSDoc 不生成文档。

但是，这样做有效：

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

是否可以记录我的云代码功能？

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) {
  //...
});