Padrão javascript

gistfile1.txt

/*   Sempre chamar o javascript de um arquivo externo (Blocos na página nunca mais)
    - partial view para os assigns do backend
      recuperar os valores via javascript.
    - incluir no bundle SEMPRE!!!
    - Não deixar lixo no código (código comentado e funções não utilizadas)
*/

// Criar funções utilizando use strict. (apenas no escopo da função)

// Documentar o código [http://usejsdoc.org/]

/* Diminuir o uso de variáveis globais
    Utilizar objetos literais var obj = {}; e Construtores var user = new User();
*/

// 80 caracteres por linha

// As funções devem realizar uma unica atividade. (Responsabilidade da mesma)

// Funções com no máximo 10 linhas (sempre que possível)

/* Declaração de variáveis:
    - Declarar no inicio da função
    - Definir um valor inicial
    - Utilizar apenas uma instrução 'var' e separar por vírgula.
*/

// Desacoplar mais o código (Responsabilidade única)

/* Utilização de ternário para if simples.
     var valor = indVenda ? valorVenda : valorLocacao;
*/

// Validar os parâmetros de entrada (sempre que possível)

// Utilizar comparador de tipo e valor '===' ou '!=='

/* Não modificar o tipo da variável, exemplo:
    var texto = "teste";
    texto = 0;
*/

  /* Ter um arquivo 'config.js' com todas as chaves default, exemplo: (opcional)

    var TransacaoImovel = function () {
        NaoInformado,
        Venda,
        Locacao,
        LocacaoTemporada,
        Lancamento
    };
*/


// Usar try/catch e tratar os erros no catch (sempre que possível)

// Usar CamelCase

// Sempre utilizar ';'

// Padronizar aspas "" ou ''

// Usar função parseInt(<var>, 10), para converter string pra int, na base 10

// Sempre usar chaves {}, mesmo em funções/ condições de uma linha

// Sempre usar chaves {}, mesmo em funções/ condições de uma linha (Parece anti-pattern)

// Utilizar JSLint (http://www.jslint.com/) para validação do JavaScript (Code Analisys)

// Refatorar sempre que possível

// Pra um dia conseguir-mos (Testes Unitários)

// Escrever o código para pessoas!


/**
 * getStateUser
 * @desc retorna os dados do usuário
 */
function getStateUser() {
    "use strict";

    var user = new User(),
        STATE = "São Paulo";

    user.setState(STATE);

    return user;
}