AngularJs ngdocs：標註一個方法返回一個承諾

Question

即時通訊目前是在記錄我第一次真正AngularJs應用程序的過程中，對於至極一個正在使用ngdocs與咕嚕-ngdocs語法

我在想，如果有更好的的方式來詮釋我的服務方法返回一個承諾（所以你知道你應該追加一個。那麼（）而不是訪問返回的對象

* @returns {object} returns a promise 

服務的

完全上下文：

/** 
* @ngdoc service 
* @name appServices.Authentication 
* @requires $http 
* @description 
* Service used to authenticate request to an api. It injects a session parameter into each request if the token parameter is set. 
* (as a request param for a GET and as an extra body param for a POST) 
**/ 
module.factory('Authentication', ['$http', function ($http) { 

    var token; 

    /** 
    * @ngdoc method 
    * @name appServices.Authentication#login 
    * @methodOf ng.service 
    * @returns {object} returns a promise 
    */ 
    function login(email, password) { 
     return $http.post('/auth/login', {email: email, password: password}) 
      .then(function (response) { 

       if (response.data.token) { 
        token = response.data.token; 
       } 
      }); 
    } 

    function getToken() { 
     return token; 
    } 

    return { 
     login: login, 
     token: getToken, 
    }; 
}]); 

Answer 1

你可以簡單寫下：

* @returns {Promise} returns a promise