從Parse.com雲代碼生成JSDocs

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() {
}

是否可以記錄我的雲代碼功能？

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