padronização

Home	Cronograma	Sprints	Requisitos	Gerência de Projeto	Horários Disponiveis
Mockups	Banco de Dados	Material de estudo	Arquitetura	Git Workflow	Configuração
Padronização do Código	Testes

Convenções de Nomenclatura

Arquivos:

O nome do arquivo deve iniciar com letra maiúscula e o restante em minúsculas. Caso seja um nome composto por mais de uma palavras, as primeiras letras de cada uma deve ser maiúscula acompanhada por letras minúsculas. Conforme os exemplos listados abaixo:

Componente: ExemploComponent

Container: ExemploContainer

Screen ExemploScreen

Classes:

As classes devem seguir o mesmo padrão de nomenclatura dos arquivos, onde ambos possuem o mesmo nome. Ou seja, um arquivo chamado TesteComponent deve possuir a seguinte nomenclatura de classe exportada:

export default class TesteComponent extends Component {
}

## Documentação do Código com javadoc

Os comentários devem estar localizados imediatamente antes da definição da classe. Cada comentário pode conter uma descrição textual sobre a classe ou membro, parâmetros da classe e um exemplo de utilização do Componente ou Container.

/**
 * @author Bruno Guerra e Eduardo Lessa
 * @param title String com o título a ser exibido
 * @param description String com a descrição doUso do TextInsertContainer título (opcional)
 * @param titleDescViewStyle StyleSheet com os estilos do <View> do componente TitleDescComponent (opcional)
 * @param titleDescStyle StyleSheet com os estilos do texto do componente TitleDescComponente (opcional)
 * @param requiredInput Booleano que indica se o input é obrigatório ou não
 * @param inputDescription Descrição do input do TextInputContainer
 * @param initialContent Conteúdo inicial do input do TextInputContainer
 * @param keyboardType Tipo do teclado do TextInputContainer
 * @param buttonViewStyle StyleSheet com os estilos do <View> do componente DefaultButtonComponent
 * @param buttonText Texto do botão do container
 * @param altBtnText Texto alternativo do botão
 * @param btnAction (Opcional) Ação (função) que o botão deve executar quando clicado. Por padrão, envia os dados para o componente pai utilizando callback.
 * 
 * Utiliza os componentes: TitleDescComponent, DefaultButtonComponent e TextInputContainer
 * 
 * Uso do StyleSheet: StyleSheet.create({ ... });
 * 
 * Exemplo de uso: <TitleInputContainer title="Meus dados" buttonText="Enviar"/>
 */