我刚刚开始使用grunt-ngdocs来处理我的角度应用,到目前为止一直很好。
但我现在想在我的一个控制器中记录另一个记录的属性的一些属性。
请考虑以下代码:
(function() {
'use strict';
/**
* @ngdoc controller
* @name app.mymodule.controller:MyController
* @description
* A Controller
*/
angular
.module('app.mymodule')
.controller('MyController', Controller);
Controller.$inject = ['someService', 'otherService', '$state'];
function Controller(someService, otherService, $state) {
/**
* @ngdoc property
* @name vm
* @propertyOf app.mymodule.controller:MyController
* @description
* A named variable for the `this` keyword representing the ViewModel
*/
var vm = this,
searchText;
vm.customerService = customerService;
vm.fetchCollection = fetchCollection;
vm.deleteCustomer = deleteCustomer;
initialise();
function initialise() {
//logic
}
/**
* @ngdoc
* @name fetchCollection
* @methodOf app.mymodule.controller:MyController
*
* @description
* Function to retrieve records from the backend service
* @example
* vm.fetchCollection(page, perPage);
* @param {int} page The number of the page of data to be retrieved
* @param {int} perPage The number of items per page to be retrieved
* @returns {object} The response object returned from a httpPromise
*/
function fetchCollection(page, perPage){
//logic
}
function deleteCustomer(model) {
//logic
}
})();
正如您所看到的,我在vm变量上挂了一些属性,这些属性通常是对控制器中定义的函数的引用。
使用上面的ngdocs \ _ jsdocs文档语法,我可以在我的文档文件夹中输出vm属性,但我不确定如何记录vm对象本身的属性。
有合理或推荐的方法吗?我确实想知道没有完全记录vm,只是单独记录每个vm.xxx,但我对此不太确定!
由于