Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • appoio-wiki appoio-wiki
  • Project information
    • Project information
    • Activity
    • Labels
    • Planning hierarchy
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • APPOIO
  • appoio-wikiappoio-wiki
  • Wiki
  • padronizacao

padronizacao · Changes

Page history
Create padronizacao authored Sep 02, 2020 by João Flores de Leão's avatar João Flores de Leão
Show whitespace changes
Inline Side-by-side
padronizacao.md 0 → 100644
View page @ b6f31de3
# 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:
Components: `ExemploComponent.js`
Screen: `ExemploScreen.js`
# 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
Os seguintes dados deverão ser utilizados nessa ordem:
* Descrição da função do arquivo criado
* `@author` Nome dos criadores do arquivo separado por vírgulas.
* `@param nome` Parâmetro que o _Component_ ou _Screen_ precisa para ser executado (prop).
* `@example` Exemplo de chamada do _Component_ ou _Screen_.
O trecho de código abaixo apresenta uma exemplificação da documentação de um componente de botão simples.
```
/**
* Componente de botão básico
*
* @author João Leão, Rafael Araujo e Eduardo Cardoso
* @param name Texto a ser exibido dentro botão
* @param onClick Ação a ser realizada pelo botão
* @example <ButtonComponent
* name={"Fazer Login"}
* action={login}
* />
*/
```
# Código
Depois da documentação, os códigos de _Component_ e de _Screen_ deve seguir a seguinte formatação:
* Importações necessárias
* Função necessárias
* Função default com retorno em HTML
* Constante da estilização do componente
O exemplo abaixo apresenta o formato que deve ser seguido. Trechos acompanhados do símbolo **$** devem ser substituídos pelo código desenvolvido (a não ser que não seja necessário).
```javascript
import React from 'react';
import { StyleSheet, $componentsToImport } from 'react-native';
$functions
export default function $name(props) {
return (
$htmlCode
);
}
const styles = StyleSheet.create({
$style
});
```
\ No newline at end of file
Clone repository
  • Rotas
  • arquitetura
  • banco_dados
  • configuracao
  • deploy
  • escopo
  • git_workflow
  • gp
  • Home
  • instalacao
  • mockups
  • padronizacao
  • processo
  • qualidade