Angular-jsdoc - 如何记录复杂的方法

时间:2015-12-14 15:48:27

标签: angularjs jsdoc

我开始使用angular-jsdoc作为文档我的AngularJS代码。 我有一些服务方法。

一些方法,用另一种方法返回一个对象: 这是我的服务示例(使用简单方法和复杂方法)

angular.module('map').service('pointUtils', function ($http) {
    var self = this;

    // simple function
    self.removeAllPoints = function () {
        // remove all points
    };

    // complex function
    self.createPoint = function (params) {
        var pointData = {
            isVisible :params.isVisible || true,
            color : params.color || 'blue'
        };

        var pointObj = {};

        pointObj.setColor = function (color) {
            pointData.color = color;
        };
        pointObj.getColor = function () {
            return pointData.color;
        };
        pointObj.setVisible = function (visible) {
            pointData.isVisible = visible;
        };

        return pointObj
    };
});

记录这种复杂方法的方法是什么?

感谢, 幼狮

0 个答案:

没有答案