Javadoc
How to Write Doc Comments for the Javadoc Toolhttp://java.sun.com/j2se/javadoc/writingdoccomments/
Javadoc 5.0 Tool
http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/index.html
Documentação Java (Sun)
Java 1.6 API reference: http://java.sun.com/javase/6/docs/api/Convenções para Codificação em Java
É obrigatório seguir as seguintes regras na codificação de programas em Java:- 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.
- 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.
- 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().
- 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.
- 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.
- 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.
- 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/.
- Usar bons nomes para as variáveis. Apesar desta directiva ser subjectiva, evitar ser muito verboso ou sucinto.
- Não usar métodos "deprecated".
- Remover código obsoleto ou não usado (não se limitar a comentá-lo).
Ficheiros para Instalação
Esta informação destina-se a permitir aos alunos trabalhar em ambientes que não o canónico.
AVISO: a avaliação apenas considera o ambiente canónico. Quaisquer resultados obtidos em outros ambientes serão sumariamente ignorados. Os alunos devem certificar-se do bom funcionamento dos seus programas no ambiente canónico.
- Java para Linux:
http://java.sun.com/ (ou utilizar os pacotes correspondentes à distribuição em uso).
- Java para Windows: http://java.sun.com/
- Java para MacOS X: http://developer.apple.com/java/