freeCodeCamp/guide/portuguese/documentation/index.md

13 lines
1.1 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters!

This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden characters.

---
title: Code documentation
localeTitle: Documentação de código
---
## Documentação de código
A documentação do código é uma maneira de os desenvolvedores escreverem seu código para criar as melhores versões de suas funções possíveis. Documentações de código permite que o novato para se familiarizar com o costume do módulo particular, função etc para uma determinada linguagem de programação.É sempre recomendado para ir com a documentação antes de depurar o código, isso ajuda você a depurar de forma eficaz.Por exemplo, você deve ser capaz de repassar seu código para um iniciante absoluto e eles devem ser capazes de acompanhar por meio de comentários, nomes de variáveis apropriados e código de estruturação de maneira espaçada e legível.
Pode tornar-se uma ideia extremamente importante criar o hábito de comentar suas funções, loops e declarações e tratar os comentários como parte do código-fonte, assim como o código regular deveria ser.
![Um exemplo de comentar no mundo real](https://cdn-images-1.medium.com/max/1620/1*Pyxsc7Uixbitv5myywaA_Q.jpeg)
#### Mais Informações: