2.0 KiB
| title | localeTitle |
|---|---|
| Code documentation | Documentação de código |
Documentação de código
A documentação de código serve como um guia informativo sobre as funcionalidades de um software, pois oferece uma descrição das funções e recursos implementados pelos desenvolvedores. Esse tipo de documentação permite que um desenvolvedor novato, por exemplo, possa se familiarizar com o formato particular utilizado nos módulos e funções do projeto de software sob uma determinada linguagem de programação. Nesse sentido, é sempre recomendado que a documentação de código seja consultada antes de qualquer depuração para que ela o ajude a tornar esse processo mais eficaz e direcionado. Nesse sentido, documentar o código significa que será possível, por exemplo, que um iniciante no projeto possa acompanhar facilmente o que está sendo desenvolvido, porque os comentários adicionados são claros e descritivos, os nomes das variáveis são apropriados e o código está legível, espaçado e bem estruturado.
Uma ideia que pode se tornar um importante hábito entre os desenvolvedores é a de descrever, por meio de comentários, as funções, declarações e laços implementados. Assim, da mesma forma como o código em si, os comentários adicionados farão parte do código-fonte do projeto.
Mais Informações:
*Medium Article about Code Documentation
*Code Tuts top 15 Best Practices