Javadoc

• Javadoc Tool
  
• How to Write Doc Comments for the Javadoc Tool
• Javadoc FAQ
• Java SE Documentation at a Glance

Versões

• O ambiente oficial de avaliação usa Java 17 ou superior.
• O material de apoio (uso obrigatório) é compatível com Java 14 ou superior.

Documentação Java (Oracle)

• Java Platform Standard Edition 17 Documentation 
  https://docs.oracle.com/en/java/javase/17/

Convenções para Codificação em Java

É obrigatório seguir as seguintes regras na codificação de programas em Java:

1. Não colocar mais do que uma instrução por linha. Uma instrução deve espalhar-se por múltiplas linhas para que nenhuma linha ocupe (idealmente) mais do 70 caracteres.
2. Os nomes das classes devem começar por uma maiúscula. As letras seguintes devem ser minúsculas, excepto no início de novas palavras. Evitar o uso de abreviaturas e acrónimos. Não usar underscores (_). Bons nomes para uma classe: Gato, PeleDeGato. Maus nomes para uma classe: gato, PULGA, Gato_pata.
3. Os nomes dos métodos devem ser verbos e começar com letras minúsculas. As letras subsequentes devem também ser minúsculas, excepto se forem a primeira letra de novas palavras. Não usar underscores (_). Bons nomes para métodos: run(), runFast(), eat(), callJerry(). Maus nomes para métodos: felix(), Aceder(), obter_Peso().
4. Os nomes das variáveis também devem começar com letras minúsculas. As letras subsequentes devem também ser minúsculas, excepto se forem a primeira letra de novas palavras. Não usar underscores (_). Os nomes das variáveis devem ser curtos, mas com significado. Nomes de variáveis com uma letra devem ser evitados, excepto se a variável é temporária (e.g. um índice de um ciclo com poucas instruções). Bons nomes para variáveis: length, cat, myLength. Maus nomes para variáveis: Felix, meu_Comprimento.
5. Variáveis de instância e de classe (static) devem começar com underscores (_) seguidos de letras minúsculas , excepto se forem a primeira letra de novas palavras. Bons nomes: _pessoa, _contador, _totalCount. Maus nomes: _Pessoa, Contador, dia.
6. Variáveis declaradas como "final" e usadas como constantes devem ter nomes constituídos por letras maiúsculas e traços de união. Bons nomes para constantes: NUM_OSSOS, MAX_PONTOS.
7. Ser consistente na colocação das chavetas, identação, e espaços. Em caso de dúvida, seguir o exemplo da codificação disponibilizada ou consultar: http://java.sun.com/docs/codeconv/.
8. Usar bons nomes para as variáveis. Apesar desta directiva ser subjectiva, evitar ser muito verboso ou sucinto.
9. Não usar métodos "deprecated".
10. Remover código obsoleto ou não usado (não se limitar a comentá-lo).