Java em poucas palavras (Portuguese Edition), 9th Edition
by Benjamin J. Evans, Jason R. Clark, David Flanagan
Capítulo 7. Convençõesde programação e documentação
Este trabalho foi traduzido com recurso a IA. Agradecemos o teu feedback e comentários: translation-feedback@oreilly.com
Este capítulo explica várias convenções importantes e úteis de programação e documentação em Java. Ele aborda:
-
Convenções gerais de nomenclatura e uso de maiúsculas
-
Dicas e convenções de portabilidade
-
Sintaxe e convenções dos comentários de documentação
javadoc
Convenções de nomenclatura e uso de maiúsculas
As seguintes convenções de nomenclatura, amplamente adotadas, se aplicam a módulos, pacotes, classes, interfaces, métodos, campos e constantes em Java. Como essas convenções são seguidas quase que universalmente e afetam a API pública das classes que você define, é bom que você também as adote:
- Módulos
-
Como os módulos são a unidade de distribuição preferida para aplicativos Java a partir do Java 9, você deve tomar um cuidado especial ao nomeá-los.
Os nomes dos módulos precisam ser globalmente únicos — o sistema de módulos se baseia basicamente nessa premissa. Como os módulos são, na prática, superpacotes (ou agregados de pacotes), o nome do módulo deve estar intimamente relacionado aos nomes dos pacotes agrupados nele.
Uma maneira recomendada de fazer isso é agrupar os pacotes dentro de um módulo e usar o nome raiz dos pacotes como nome do módulo. Por exemplo, se todos os pacotes de uma aplicação estiverem em
com.mycompany.*, entãocom.mycompanyé um bom nome para o seu módulo. - Pacotes
-
É comum ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access