Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Produzir arquivos com padrões de documentação de código #48

Open
3 tasks
lucasqueiroz23 opened this issue Nov 20, 2023 · 0 comments
Open
3 tasks

Produzir arquivos com padrões de documentação de código #48

lucasqueiroz23 opened this issue Nov 20, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request organização Indica que a issue tem como foco a organização do repositório

Comments

@lucasqueiroz23
Copy link
Collaborator

Problema

Código bem documentado é bom para que todos possam entender as motivações do programador ao solucionar um problema.

Solução

Produzir um documento com padronizações para documentação de código

Branch: padronizacao_doc_codigo

Principais Tasks

  • Produzir uma sessão para nomes de funções, variáveis, etc
  • Produzir uma sessão para comentários genéricos
  • Produzir uma sessão para comentários de funções, classes, métodos, etc

Links

Colocar links de protótipo, de campos ou documentos necessários para que o desenvolvedor possa encontrar de forma mais ágil.

Dificuldades

Fale sobre alguma dificuldade que está encontrando ao processo de finalização da issue.

@lucasqueiroz23 lucasqueiroz23 added documentation Improvements or additions to documentation enhancement New feature or request organização Indica que a issue tem como foco a organização do repositório labels Nov 20, 2023
@lucasqueiroz23 lucasqueiroz23 self-assigned this Nov 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request organização Indica que a issue tem como foco a organização do repositório
Projects
None yet
Development

No branches or pull requests

1 participant