Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • C calculadora-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
  • Calculadora
  • calculadora-wiki
  • Wiki
  • Padronização

Padronização · Changes

Page history
Create Padronização authored Sep 06, 2020 by Guilherme Sbroglio Rizzotto's avatar Guilherme Sbroglio Rizzotto
Show whitespace changes
Inline Side-by-side
Padronização.md 0 → 100644
View page @ 7f5e6379
|[Página Inicial](home)|
|---|
# Nomenclatura de Arquivos
Na nomenclatura dos arquivos, sempre utilizar cameCase e começar com letra maiuscúla. Dependendo do arquivo que está sendo criado é necessário que a sua funcionalidade seja adicionada ao nome.
Components: `ExemploComponent.js`
# Documentação
A documentação deve estar presente em todos os *Components* e *Pages* criadas. A documentação deverá estar localizada no topo do código, antes mesmo das importações
Dados que devem ser comtemplados:
- `@author` Nome dos criadores do arquivo separado por vírgulas.
- `@prop` Props que o **Component** possui, nao precisa para outros tipos.
- `@example` Exemplo de chamada do *Component* ou Page.
O trecho de código abaixo apresenta uma exemplificação da documentação de um componente de botão simples.
```
/**
*
*
* @author Guilherme Rizzotto
* @prop placeholder Placeholder do Input
* @prop onClick Ação a ser realizada pelo input
* @example <InputComponent
* placeholder="Fazer Login"
* onClick={handleOnClick}
* />
*/
```
# Código
Depois da documentação, os códigos devem seguir a seguinte formatação:
- Importações necessárias
- Função necessárias
- return com JSX
O exemplo abaixo apresenta o formato que deve ser seguido.
\ No newline at end of file
Clone repository
  • Padronização
  • Utilizando a wiki
    • adicionando imagens
    • escrevendo em markdown
    • wiki no editor de texto
  • arquitetura
  • backend
  • banco_dados
  • configuracao
  • git
  • gp
  • Home
  • horarios
  • instalacao
  • mockups
  • requisitos
View All Pages