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