Code Convention

Code Convention Definições • Pascal Casing: Primeira letra da todas as palavras são maiúsculas. Exemplo: BackColor, FirstName • Camel Casing: Primeira letra de todas as palavras são maiúsculas expeto da primeira palavra. Exemplo: backColor, firstName • Prefixo: Primeira letra ou palavra corresponde a um indicador. Exemplo: lblLabel, btnButton Regras 1. Língua: Tudo em Inglês. 2. Nomes: Não usar abreviaturas. 3. Nomes dos ficheiros: Usar pascal casing 4. Nomes de funções: Usar pascal casing

5. Nomes de classes, incluindo CSS: Usar pascal casing 6. Nomes de interfaces: Usar prefixo ‘I’ 7. Nomes de eventos: Usar prefixo ‘Event’ 8. Nomes dos elementos/objetos: Usar pascal casing 9. Repositórios: Usar prefixo ‘Rep’ 10. Nomes de variáveis 10.1. Usar camel casing 10.2. Não usar uma única letra como variável, exceto em ciclos 10.3. Sempre que possível e que a linguagem de programação permita, usar: ‘int’, ‘double’, ‘string’, etc… em vez de ‘var’ (este último terá ser usado em javascript)

11. Posição das variáveis: No início da função 12. Ordenação do código 1 – Classes 2 – Funções 3 – Eventos

13. Booleanas: Verificar sem operadores 14. TAB: usar sempre a TAB após abrir chavetas em vez de espaços (no visual studio autoformação usando CTRL K CTRL D) 15. Parênteses: Usar para dividir diferentes lógicas de códigos

16. Uma linha em branco para separar funções, classes, eventos, etc… 17. Uma linha em branco para separar grupos de código que tenham uma lógica diferente 18. Um espaço entre cada operador (no visual studio autoformação usando CTRL K CTRL D)

19. Region: Usar para agrupar código • C# o #region MyRegion o //Código o #endregion • Html (instalar extensão WebEssencials) o <!-- #region name --> o <!-- Código --> o <!-- #endregion --> • Javascript (instalar extensão WebEssencials) o //#region name o //Código o //#endregion Em que MyRegion e name devem ser substituídos por uma referência do que vai ser escrito. Além disso, as regiões podem ocultar para uma facilidade de leitura usando em C# CTRL M CTRL O (Ativar 'Collapse #regions when collapsing to definitions' em Tools -> Options -> Text Editor -> C# -> Advanced) e restantes linguagens CTRL M CTRL L.

20. Juntar Strings (C#): Usar StringBuilder 21. Comentários 21.1. Colocar comentário numa linha separada, não numa linha de código 21.2. Começar texto com letra maiúscula 21.3. Terminar texto do comentário com ponto final 21.4. Um espaço entre // e o texto 21.5. Não usar /* */ 22. Usar sempre código estruturado em vez de código simplificado 23. Operadores em JavaScript: Usar sempre os operadores ‘===’ e ‘! ==’ em vez de ‘==’ e ‘! =’ respetivamente