Padronização (e dicas)

Nome de arquivos

(Todos os arquivos .java devem começar com letra maiúscula)

Arquivos de Models: nome da entidade em inglês. Ex: User.java

Interfaces de Repositórios: nome da entidade em inglês, seguido de Repository. Ex: UserRepository.java

Controllers: nome da respectiva model (entidade) em inglês, seguido de Controller. Ex: UserController.java

Services: nome da respectiva model (entidade) em inglês, seguido de Service. Ex: UserService.java

Nome de métodos de Controllers

GET retornando página do sistema: 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.

POST advindo de uma página: 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 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.

Para formatar e deixar um arquivo mais limpo, use Ctrl + Alt + Shift + l no IntelliJ para usar o Reformat.