-
Notifications
You must be signed in to change notification settings - Fork 1
2.3 JavaScript
O guia de estilo para JavaScript é baseado no documento escrito por Douglas Crockford. Se alguma regra não estiver escrita aqui tome o documento original como base.
Importe um arquivo JavaScript externo, não misture-o com o código html.
<script src="myscript.js"></script>Use tags <script> o mais tarde possível (geralmente antes de fechar a tag body). Isso reduz o atraso para carregar uma página. Não é necessário adicionar os atributos type ou language.
<html>
<body>
<script> alert("Hello! Eu tô no guia de estilo!!"); </script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/Swiper/3.3.1/js/swiper.jquery.min.js"></script>
</body>
</html>Evite escrever linhas com mais de 120 caracteres. Em alguns casos será necessário 'quebrar' comandos. Nesse caso quebre a linha depois de um operador.
Use comentários somente se necessário. Não comente coisas óbvias como:
var i = 0; // Atribui à variável i o valor zero.
Você deve comentar funções utilizando o padrão DocBlock:
/**
* Descrição do método...
*
* @method myFunction
* @param {String} myVariable
* @return {Array}
*/
function myFunction(myVariable) {
return [myVariable];
}
Sempre declare variáveis antes de usá-las.
var name;
var email;
Todas as funções devem ser declaradas antes de serem utilizadas. Não deve haver espaço entre o nome da função e o parêntese de abertura (), mas deve haver um espaço no fechar de parênteses e abertura de chaves {.
function validate(attribute, options) {
return true;
}Ao definir variáveis e funções opte por utilizar valores que tenham signicado e que expressem o que será armazenado ou calculado na mesma.
Todos os comandos devem ser terminados por ponto e vírgula ;.