diff --git a/guide/portuguese/documentation/index.md b/guide/portuguese/documentation/index.md index 4b41988737..c3cccbc939 100644 --- a/guide/portuguese/documentation/index.md +++ b/guide/portuguese/documentation/index.md @@ -4,10 +4,18 @@ 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. +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. -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. +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. -![Um exemplo de comentar no mundo real](https://cdn-images-1.medium.com/max/1620/1*Pyxsc7Uixbitv5myywaA_Q.jpeg) +![Um exemplo de comentário no mundo real](https://cdn-images-1.medium.com/max/1620/1*Pyxsc7Uixbitv5myywaA_Q.jpeg) -#### Mais Informações: \ No newline at end of file +#### Mais Informações: + +*[Medium Article about Code Documentation](https://medium.com/@andrewgoldis/how-to-document-source-code-responsibly-2b2f303aa525) + +*[Code Tuts top 15 Best Practices](https://code.tutsplus.com/tutorials/top-15-best-practices-for-writing-super-readable-code--net-8118) + +*[Medium Article "The Good, The Bad, The Ugly"](https://medium.freecodecamp.org/code-comments-the-good-the-bad-and-the-ugly-be9cc65fbf83) + +*[Medium Article about how to document source code](https://medium.com/@andrewgoldis/how-to-document-source-code-responsibly-2b2f303aa525)