Comments

ou Comentários

jsDoc

• Se você planeja produzir documentação, use a sintaxe jsDoc para documentar nomes, descrições, parâmetros e retornos de funções. Use @namespace e @memberOf para adequar à estrutura de sua aplicação.

  Por que? Você pode gerar (e regerar) documentação a partir do seu código ao invés de escrever do zero.

  Por que? Fornece consistência utilizando uma ferramenta comum no mercado.

  /**
   * Logger Factory
   * @namespace Factories
   */
  (function() {
    angular
        .module('app')
        .factory('logger', logger);
  
    /**
     * @namespace Logger
     * @desc Application wide logger
     * @memberOf Factories
     */
    function logger($log) {
        var service = {
           logError: logError
        };
        return service;
  
        ////////////
  
        /**
         * @name logError
         * @desc Logs errors
         * @param {String} msg Message to log
         * @returns {String}
         * @memberOf Factories.Logger
         */
        function logError(msg) {
            var loggedMsg = 'Error: ' + msg;
            $log.error(loggedMsg);
            return loggedMsg;
        };
    }
  })();
  

De volta ao topo