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

Last edited by Guilherme Sbroglio Rizzotto Sep 09, 2020
Page history
This is an old version of this page. You can view the most recent version or browse the history.

Padronização

Página Inicial

Nomenclatura de Arquivos

Na nomenclatura dos arquivos, sempre utilizar pascalCase 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 - Front

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 - Front

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.

imports

handlers

return (
    <>
    </>
)
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