|
|[Home](home)|[Sprints](sprints)|[Requisitos](requisitos)|[Arquitetura](arquitetura)|[Configuração](configuracao)|[Mockups](mockups)|[Banco de Dados](banco_dados)|[Instalação](instalacao)|[Gerência](gp)|[Time](time)|[Padronização](padronizacao)|[Git Workflow](git)|
|
|
|[Home](home)|[Sprints](sprints)|[Requisitos](requisitos)|[Arquitetura](arquitetura)|[Configuração](configuracao)|[Mockups](mockups)|[Banco de Dados](banco_dados)|[Instalação](instalacao)|[Gerência](gp)|[Time](time)|[Padronização](padronizacao)|[Git Workflow](git)|
|
|
|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
## Padronização de desenvolvimento para o front-end
|
|
# Front-End
|
|
|
|
|
|
# Nomenclatura de Arquivos
|
|
### Nomenclatura de Arquivos
|
|
Na nomenclatura dos arquivos cada palavra deve ser iniciada com letra maiúscula seguida de letras minúsculas (sem espaço, underline ou hífen). Dependendo do arquivo que está sendo criado é necessário que o sua funcionalidade seja adicionada ao nome. Podemos ver melhor essa regras nos exemplos abaixo:
|
|
Na nomenclatura dos arquivos cada palavra deve ser iniciada com letra maiúscula seguida de letras minúsculas (sem espaço, underline ou hífen). Dependendo do arquivo que está sendo criado é necessário que o sua funcionalidade seja adicionada ao nome. Podemos ver melhor essa regras nos exemplos abaixo:
|
|
|
|
|
|
Components: `ExemploComponent.js`
|
|
Components: `ExemploComponent.js`
|
|
|
|
|
|
Screen: `ExemploScreen.js`
|
|
Screen: `ExemploScreen.js`
|
|
|
|
|
|
# Documentação
|
|
### Documentação
|
|
A documentação deve estar presente em todos os _Components e _Screens_ criadas. A documentação será feita com JavaDoc e deverá estar localizada no topo do código, antes mesmo das importações
|
|
A documentação deve estar presente em todos os _Components e _Screens_ criadas. A documentação será feita com JavaDoc e deverá estar localizada no topo do código, antes mesmo das importações
|
|
|
|
|
|
Os seguintes dados deverão ser utilizados nessa ordem:
|
|
Os seguintes dados deverão ser utilizados nessa ordem:
|
... | @@ -38,7 +38,7 @@ O trecho de código abaixo apresenta uma exemplificação da documentação de u |
... | @@ -38,7 +38,7 @@ O trecho de código abaixo apresenta uma exemplificação da documentação de u |
|
|
|
|
|
|
|
|
|
|
|
|
|
# Código
|
|
### Código
|
|
Depois da documentação, os códigos de _Component_ e de _Screen_ deve seguir a seguinte formatação:
|
|
Depois da documentação, os códigos de _Component_ e de _Screen_ deve seguir a seguinte formatação:
|
|
|
|
|
|
* Importações necessárias
|
|
* Importações necessárias
|
... | @@ -63,4 +63,28 @@ export default function $name(props) { |
... | @@ -63,4 +63,28 @@ export default function $name(props) { |
|
const styles = StyleSheet.create({
|
|
const styles = StyleSheet.create({
|
|
$style
|
|
$style
|
|
});
|
|
});
|
|
``` |
|
```
|
|
\ No newline at end of file |
|
|
|
|
|
|
|
|
|
# Back-End
|
|
|
|
|
|
|
|
### Nomenclatura de Arquivos
|
|
|
|
Todos arquivos, com exceção dos "index.js", devem fazer uso do padrão PascalCase, ou seja, primeira letra de cada palavra deve ser maiúscula.
|
|
|
|
|
|
|
|
![exemplo de arquivo](https://tools.ages.pucrs.br/appoio/appoio-wiki/raw/master/images/arquitetura/Formato_Arquivo.png)
|
|
|
|
|
|
|
|
### Classes
|
|
|
|
As classes devem ser nomeadas no singular e fazendo uso do padrão PascalCase para nomeação, ou seja, primeira letra de cada palavra deve ser maiúscula.
|
|
|
|
|
|
|
|
![exemplo de classe](https://tools.ages.pucrs.br/appoio/appoio-wiki/raw/master/images/arquitetura/Formato_Classe.png)
|
|
|
|
|
|
|
|
### Funções e Variáveis
|
|
|
|
As variáveis utilizadas no programa devem fazer uso do padrão camelCase para nomeação, ou seja, primeira letra minúscula e a separação das palavras é por letra maiúscula.
|
|
|
|
|
|
|
|
![exemplo de código](https://tools.ages.pucrs.br/appoio/appoio-wiki/raw/master/images/arquitetura/Formato_Código.png)
|
|
|
|
|
|
|
|
|
|
|
|
### Documentação
|
|
|
|
Fazer uso de comentários com /**/ logo acima do pedaço de código que irá ser documentado, pode incluir marcações como @example, @param, @returns, idealmente devem ser incluídas todas as marcações, mas caso não seja simples/possível deve ter ao menos @param e @returns na documentação.
|
|
|
|
|
|
|
|
![exemplo documentação](https://tools.ages.pucrs.br/appoio/appoio-wiki/raw/master/images/arquitetura/Formato_Documentacao.png) |
|
|
|
\ No newline at end of file |