Mudanças entre as edições de "Padrões Front-End"
(Criou página com '= Padrões de desenvolvimento de Front-End = ==1.1 Ambientes de desenovlvimento(IDE) definidos == Deve ser adotado para o desenvolvimento de códigos de front-end como padr...') |
|||
| Linha 1: | Linha 1: | ||
= Padrões de desenvolvimento de Front-End = | = Padrões de desenvolvimento de Front-End = | ||
| − | ==1. | + | ==1.Ambientes de desenovlvimento(IDE) definidos == |
Deve ser adotado para o desenvolvimento de códigos de front-end como padrão de IDE (Integrated Development Environment): | Deve ser adotado para o desenvolvimento de códigos de front-end como padrão de IDE (Integrated Development Environment): | ||
| Linha 11: | Linha 11: | ||
'''Obs.:''' Tanto o '''Visual Studio''' quanto o '''JetBrains WebStorm''' são soluções pagas, com licenças adquiridas pela MSTECH. Antes de instalar, consulte o GTI para verificar a disponibilidade de licença. | '''Obs.:''' Tanto o '''Visual Studio''' quanto o '''JetBrains WebStorm''' são soluções pagas, com licenças adquiridas pela MSTECH. Antes de instalar, consulte o GTI para verificar a disponibilidade de licença. | ||
| − | == | + | ==2. Padrão de Bibliotecas == |
Para o desenvolvimento de códigos Javascript, ficou acordado que será utilizado ou o Javascript Nativo ou o '''"AngularJS", na versão 1'''. | Para o desenvolvimento de códigos Javascript, ficou acordado que será utilizado ou o Javascript Nativo ou o '''"AngularJS", na versão 1'''. | ||
| Linha 17: | Linha 17: | ||
Estão em análise e estudo para adoção futura o '''"AngularJS 2"''' e o '''"Vue.JS"'''. Entretanto, estes não deverão ser utilizados ainda em sistemas destinados à clientes. | Estão em análise e estudo para adoção futura o '''"AngularJS 2"''' e o '''"Vue.JS"'''. Entretanto, estes não deverão ser utilizados ainda em sistemas destinados à clientes. | ||
| − | == | + | ==3. Padrão de comentários de códigos e APIs == |
Para comentários em front-end, será utilizada a estrutura definida no "JSDocs". Considerar os campos com comentários padronizáveis: | Para comentários em front-end, será utilizada a estrutura definida no "JSDocs". Considerar os campos com comentários padronizáveis: | ||
| Linha 33: | Linha 33: | ||
'''Obs.:''' Em caso de ''refactor'' de um código que não está adequadamente comentado e é um trecho que precisa de informação para entendimento, adicionar comentário que responda às perguntas: '''"O quê/Para quê/Como?/Quando?"''' | '''Obs.:''' Em caso de ''refactor'' de um código que não está adequadamente comentado e é um trecho que precisa de informação para entendimento, adicionar comentário que responda às perguntas: '''"O quê/Para quê/Como?/Quando?"''' | ||
| − | == | + | ==4. Padrão de nomenclaturas== |
Nos códigos front-end, as nomenclaturas de variáveis e métodos devem ser descritos no idioma inglês. Para padronização, construiremos um [https://wikipedia.mstech.com.br/index.php?title=Gloss%C3%A1rio_de_termos_em_ingl%C3%AAs&action=edit Glossário] com a indicação do melhor termo para cada entidade. | Nos códigos front-end, as nomenclaturas de variáveis e métodos devem ser descritos no idioma inglês. Para padronização, construiremos um [https://wikipedia.mstech.com.br/index.php?title=Gloss%C3%A1rio_de_termos_em_ingl%C3%AAs&action=edit Glossário] com a indicação do melhor termo para cada entidade. | ||
Edição das 17h37min de 3 de junho de 2016
Índice
Padrões de desenvolvimento de Front-End
1.Ambientes de desenovlvimento(IDE) definidos
Deve ser adotado para o desenvolvimento de códigos de front-end como padrão de IDE (Integrated Development Environment):
- Visual Studio: para projetos que contém como parte da solução a plataforma .NET;
- JetBrains WebStorm: para os demais projetos/sistemas (caso não seja possível utilizá-lo);
- GitHub Atom: Alternativa leve para desenvolvimento, caso não haja disponibilidade do WebStorm.
Obs.: Tanto o Visual Studio quanto o JetBrains WebStorm são soluções pagas, com licenças adquiridas pela MSTECH. Antes de instalar, consulte o GTI para verificar a disponibilidade de licença.
2. Padrão de Bibliotecas
Para o desenvolvimento de códigos Javascript, ficou acordado que será utilizado ou o Javascript Nativo ou o "AngularJS", na versão 1.
Estão em análise e estudo para adoção futura o "AngularJS 2" e o "Vue.JS". Entretanto, estes não deverão ser utilizados ainda em sistemas destinados à clientes.
3. Padrão de comentários de códigos e APIs
Para comentários em front-end, será utilizada a estrutura definida no "JSDocs". Considerar os campos com comentários padronizáveis:
@description: descrição da sua função ou do método - (Obrigatório);
@author: nome do desenvolvedor e data de criação/alteração - (Obrigatório nas condições abaixo): - Quando for o criador, insere o campo no começo do documento; - Quando for alteração de uma função, insere na própria função.
@param: descrição do parâmetro (nome*, tipo*, descrição*) – (Se necessário); @callback: descrição do callback (tipo*) – (Se necessário); @return ou @returns (caso o retorno seja mais do que um) descrição do retorno: (nome, tipo*, descrição*) – (Se necessário).
Obs.: Em caso de refactor de um código que não está adequadamente comentado e é um trecho que precisa de informação para entendimento, adicionar comentário que responda às perguntas: "O quê/Para quê/Como?/Quando?"
4. Padrão de nomenclaturas
Nos códigos front-end, as nomenclaturas de variáveis e métodos devem ser descritos no idioma inglês. Para padronização, construiremos um Glossário com a indicação do melhor termo para cada entidade.
