Folha de Estilo - TecProg-2018-2/2018.1-VoxPop-WebApp GitHub Wiki

• Indentação
• Variaveis e Funções
• Classe
• Interface
• Namespace
• Enum
• null vs. undefined)
• Tabs vs. Spaces
• Array
• Parenteses
• Chaves
• Operações

• Use camelCase para nome de funçoẽs e variáveis.

Não recomendado

var FooVar;
function BarFunc() { }

Recomendado

var fooVar;
function barFunc() { }

• Use uma única declaração para cada variável quando inicializar a mesma.

Não recomendado

var x = 1; var y = 2

Recomendado

var x = 1, y = 2;

• Use PascalCase para nome de classes.

Não recomendado

class foo { }

Recomendado

class Foo { }

• Use camelCase para 'class member' e métodos.

Não recomendado

class Foo {
    Bar: number;
    Baz() { }
}

Recomendado

class Foo {
    bar: number;
    baz() { }
}

• Use PascalCase para nomes.

• Não use I no começo do nome.

Não recomendado

interface IFoo {
}

Recomendado

interface Foo {
}

• Use PascalCase para nomes.

Não recomendado

namespace foo {
}

Recomendado

namespace Foo {
}

• Use PascalCase para nomes em enums.

Não recomendado

enum color {
}

Recomendado

enum Color {
}

• Use PascalCase para enum member

Não recomendado

enum Color {
    red
}

Recomendado

enum Color {
    Red
}

• De preferência não use nenhum dos dois.

Não recomendado

let foo = {x:123,y:undefined};

Recomendado

let foo:{x:number,y?:number} = {x:123};

• Use checagem truthy paraobjetos que possam ser null or undefined

Não recomendado

if (error === null)

Recomendado

if (error)

• Use == undefined / != undefined (e não === / !==) para checar estados null / undefined.Nunca use outros valores para verificar (exemplo: '',0,false) e.g.

Não recomendado

if (error !== null)

Recomendado

if (error != undefined)

• Para arrays faça foos:Foo[] em vez de foos:Array<Foo>.

• Não deixe espaços na parte de dentro do parenteses.

Não recomendado

if ( x < 10 ) 

Recomendado

if (x < 10) 

• Após o uso das estruturas condicionais e metodos, deve se aplicar espaço antes de abrir chaves(ex: {}).
• A primeira chave deve permanecer na mesma linha do operador.
• 'else' deve estar entre chaves, e com espaço separando.

Não recomendado

if(variavel = 0)
{  
   // código
}
else
{
   // código 
}

Recomendado

if(variavel = 0) {  
   // código
} else {
   // código 
}

• Deve-se colocar espaço entre operadores.

Não recomendado

variavel=(1+2)*3;

Recomendado

variavel = (1 + 2) * 3;