Feature/feature andreza #42
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ilar/java4noobs into feature/featureAndreza
There was a problem hiding this comment.
Além dos comentários, estive pensando sobre este PR e acredito que talvez seja interessante reposicionar algumas coisas.
Pensei em algo assim, mas aceito sugestões:
Estrutura atual
# Documentação e indentação
## Documentação
# Documentação com Javadoc
## Exemplo de Comentário Javadoc
## Tags Comuns do Javadoc
## Gerando a Documentação
## IndentaçãoEstrutura nova
# Documentação
# Indentação
# Javadoc
## Exemplo de Comentário Javadoc
## Tags Comuns do Javadoc
## Gerando a DocumentaçãoO que acha @andreza-vilar?
|
|
||
| Este comando cria a documentação HTML no diretório especificado (`docs`). | ||
|
|
||
| Para mais detalhes, consulte a [documentação oficial do Javadoc](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html). |
There was a problem hiding this comment.
Ajustar para a versão LTS mais recente
Suggested change
| Para mais detalhes, consulte a [documentação oficial do Javadoc](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html). | |
| Para mais detalhes, consulte a [documentação oficial do Javadoc](https://docs.oracle.com/en/java/javase/21/docs/specs/man/javadoc.html). |
|
|
||
| Este comando cria a documentação HTML no diretório especificado (`docs`). | ||
|
|
||
| Para mais detalhes, consulte a [documentação oficial do Javadoc](https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html). |
There was a problem hiding this comment.
Talvez seja interessante deixar o link da documentação do Java como exemplo de output do javadoc
Comment on lines
+59
to
+67
| ## Gerando a Documentação | ||
|
|
||
| Para gerar a documentação, use o comando `javadoc` no terminal: | ||
|
|
||
| ```sh | ||
| javadoc -d docs src/com/exemplo/Calculadora.java | ||
| ``` | ||
|
|
||
| Este comando cria a documentação HTML no diretório especificado (`docs`). |
There was a problem hiding this comment.
Adicionar uma observação bem breve informando que as IDEs também conseguem gerar o javadoc
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.