|
|
|
|[Página Inicial](home)|
|
|
|
|
|---|
|
|
|
|
|
|
|
|
# Padronização (e dicas)
|
|
|
|
|
|
|
|
### Nome de arquivos
|
|
|
|
|
|
|
|
(Todos os arquivos .java devem começar com letra maiúscula)
|
|
|
|
|
|
|
|
<b>Arquivos de Models:</b> nome da entidade em inglês. Ex: `User.java`
|
|
|
|
|
|
|
|
<b>Interfaces de Repositórios:</b> nome da entidade em inglês, seguido de Repository. Ex: `UserRepository.java`
|
|
|
|
|
|
|
|
<b>Controllers:</b> nome da respectiva model (entidade) em inglês, seguido de Controller. Ex: `UserController.java`
|
|
|
|
|
|
|
|
<b>Services:</b> nome da respectiva model (entidade) em inglês, seguido de Service. Ex: `UserService.java`
|
|
|
|
|
|
|
|
### Nome de métodos de Controllers
|
|
|
|
|
|
|
|
<b>GET retornando página do sistema:</b> nome do método HTTP + página referente que será retornada. Ex: retornar página de cadastro de usuário -> `getUserSignupPage()`
|
|
|
|
|
|
|
|
Os métodos GET também podem ser nomeados como `getUserById()`, onde retorna a página do usuário referente ao ID passado como parâmetro.
|
|
|
|
|
|
|
|
<b>POST advindo de uma página:</b> nome do método HTTP + nome da página / ação da qual o request veio. Ex: cadastro do usuário -> `postUserSignup()`
|
|
|
|
|
|
|
|
### Outras dicas
|
|
|
|
|
|
|
|
Para documentar o código, no IntelliJ, digite `/**` na linha acima do método e aperte Enter para que a IDE coloque o template do JavaDOC. Esse [post](https://www.devmedia.com.br/javadoc-implementando-documentacao-atraves-do-netbeans/2495) apresenta alguns conceitos importantes para documentação.
|
|
|
|
|
|
|
|
Os nomes dos métodos, variáveis, arquivos e demais artefatos Java devem seguir o padrão [CamelCase](https://codeflavor.wordpress.com/2010/03/23/camelcase-o-que-e-porque-usar/).
|
|
|
|
|
|
|
|
Para formatar e deixar um arquivo mais limpo, use `Ctrl + Alt + Shift + l` no IntelliJ para usar o Reformat. |
