从 Parse.com 云代码生成 JSDocs答案

【问题标题】：Generating JSDocs from Parse.com Cloud Code从 Parse.com 云代码生成 JSDocs
【发布时间】：2015-12-04 00:43:47
【问题描述】：

我正在将 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 函数？

【问题讨论】：

标签： parse-platform jsdoc parse-cloud-code jsdoc3

【解决方案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);

希望这对某人有所帮助。

【讨论】：

【解决方案2】：

您也可以使用@method 属性进行标记：

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

【讨论】：