Skip to content

Commit a425269

Browse files
committed
documentação breve sobre organização de classes e pacotes
1 parent 7ac6b58 commit a425269

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Organizando as classes em pacotes
2+
3+
Este é um projeto de exemplo que demonstra as boas práticas de organização de classes e pacotes em um projeto.
4+
5+
## Estrutura do Projeto
6+
7+
O projeto é estruturado da seguinte forma:
8+
9+
```
10+
projeto-exemplo/
11+
├── src/
12+
│ ├── pacote1/
13+
│ │ ├── Classe1.java
14+
│ │ ├── Classe2.java
15+
│ ├── pacote2/
16+
│ │ ├── Classe3.java
17+
│ │ ├── Classe4.java
18+
│ ├── pacote3/
19+
│ │ ├── Classe5.java
20+
│ │ ├── Classe6.java
21+
├── test/
22+
│ ├── pacote1/
23+
│ │ ├── Classe1Test.java
24+
│ │ ├── Classe2Test.java
25+
│ ├── pacote2/
26+
│ │ ├── Classe3Test.java
27+
│ │ ├── Classe4Test.java
28+
├── README.md
29+
├── LICENCE
30+
├── .gitignore
31+
```
32+
33+
34+
### Pacotes
35+
36+
Os pacotes são usados para organizar e agrupar as classes relacionadas. No exemplo acima, temos três pacotes: `pacote1`, `pacote2` e `pacote3`. É importante escolher nomes significativos para os pacotes, que reflitam a funcionalidade das classes contidas neles.
37+
38+
As classes dentro de cada pacote estão organizadas de forma lógica e coesa, facilitando a navegação e compreensão do código. Por exemplo, as classes relacionadas a determinada funcionalidade podem ser agrupadas em um único pacote.
39+
40+
### Arquivos de Código-fonte
41+
42+
Os arquivos de código-fonte estão localizados na pasta `src/`. Cada pacote possui sua própria pasta dentro de `src/`. Por exemplo, a classe `Classe1.java` está localizada em `src/pacote1/`.
43+
44+
Os arquivos de teste estão localizados na pasta `test/`. A estrutura de pastas dentro de `test/` segue a mesma estrutura de pacotes em `src/`. Por exemplo, a classe de teste `Classe1Test.java` está localizada em `test/pacote1/`.
45+
46+
### Outros Arquivos
47+
48+
Além dos arquivos de código-fonte, o projeto também possui outros arquivos importantes:
49+
50+
- `README.md`: Este arquivo contém informações sobre o projeto, sua estrutura e como utilizá-lo.
51+
- `LICENSE`: O arquivo de licença do projeto.
52+
- `.gitignore`: Arquivo que especifica quais arquivos e pastas devem ser ignorados pelo controle de versão Git.

0 commit comments

Comments
 (0)