Boas práticas para escrita de métodos, funções e procedimentos – Revista Engenharia de Software Magazine 41 - Parte 3

Você precisa estar logado para dar um feedback. Clique aqui para efetuar o login
Para efetuar o download você precisa estar logado. Clique aqui para efetuar o login
Confirmar voto
0
 (0)  (0)

Este artigo aborda o tema Código Limpo com o objetivo de mostrar como o desenvolvedor pode usá-lo para melhorar a qualidade do código-fonte de suas aplicações. A discussão deste tema é interessante uma vez que provê conhecimento ao desenvolvedor sobre como transformar códigos considerados ruins em bons códigos através de exemplos práticos das teorias aqui abordadas.

Artigo no estilo Curso

De que se trata o artigo

Aborda o tema Código Limpo com o objetivo de mostrar como o desenvolvedor pode usá-lo para melhorar a qualidade do código-fonte de suas aplicações. A discussão deste tema é interessante uma vez que provê conhecimento ao desenvolvedor sobre como transformar códigos considerados ruins em bons códigos através de exemplos práticos das teorias aqui abordadas.

Em que situação o tema é útil

O tema se torna fundamental para desenvolvedores que buscam cada vez mais melhorar suas aplicações ao focar em qualidade de código. Essa tarefa será possível graças ao conhecimento sobre limpeza de código.

Resumo DevMan

Esta série de artigos discutirá os aspectos que permeiam o assunto Código Limpo, seguindo a linha de raciocínio que propõe um aumento na qualidade do código das aplicações existentes ou proporcionar conhecimento de como criar projetos de código melhores quando se está iniciando um novo projeto. Neste contexto, código limpo se refere a um conjunto de características desejáveis de serem encontradas no código de nossa aplicação. Algumas dessas características são: ter um código que atenda os requisitos de eficiência, lógica do negócio bem modelada e definida em forma de código fonte, mecanismos de tratamento de erro bem definidos e código que não dê margem à necessidade da realização de novas otimizações.

Autores: Jacimar Fernandes Tavares e Marco Antônio Pereira Araújo

Um recurso das linguagens de programação que é utilizado em diversas situações, e por diversos motivos, são os comentários. Comentários podem ser úteis em diversas situações, e devido à facilidade de criação, algumas vezes é usado de forma inadequada.

Apesar da facilidade que é a tarefa de escrever um comentário, alguns cuidados devem ser tomados. O primeiro deles gira em torno da real necessidade de escrevê-lo. Quando um comentário é realmente útil e quando deve ser substituído por outra prática? Caso um comentário não deva ser escrito, o que fazer para substituí-lo? Além dessas questões, este artigo levará o desenvolvedor a pensar em pontos importantes que giram em torno da concepção de um comentário.

O objetivo aqui é apresentar a Seção Comentários, que gira em torno da relação comentário/código fonte. Como eles se relacionam? Onde é interessante e onde não é indicado criar um comentário? Quais os tipos de comentários existentes e quais as informações que normalmente são inseridas em um comentário?

Para que os objetivos deste artigo sejam cumpridos, a seção aqui abordada é dividida em subseções como Os comentários e a Qualidade de Código, que expõe a relação que os comentários têm com a qualidade do código no sentido de como contribuem ou como diminuem a qualidade. Em seguida, a subseção Pontos Importantes sobre as Informações Contidas nos Comentários fornece exemplos de informações comumente encontradas nos comentários. Finalizando, tem-se Os Cuidados ao Escrever um Comentário, que visa alertar sobre alguns fatores a se considerar ao se escrever um comentário para que o código fonte das aplicações se torne limpo, que é o objetivo geral desta série de artigos sobre código limpo.

Comentários

Objetivo: Uma das preocupações quando o assunto é comentário gira em torno da sua necessidade. Um comentário pode estar escondendo um trecho de código mal escrito, portanto ruim. Mas quando eles realmente são necessários? Como eles devem ser escritos? Que cuidados tomar se uma manutenção for feita em um bloco de código fonte que possui um comentário? Esta seção abordará essas questões.

Os comentários e a qualidade do código: qualidade de código vem sendo expresso nesta série de artigos, dentre outras coisas, como código limpo. No entanto, um código com muitos comentários pode estar escondendo um trecho de código considerado ruim ou sujo. É comum se deparar com trechos de códigos que, devido à grande dificuldade de analisá-lo, o desenvolvedor, na esperança de minimizar esta tarefa, acaba escrevendo comentários para auxiliar no entendimento do funcionamento do seu código. Alguns desenvolvedores chegam a solicitar a outros colegas de profissão que criem códigos bem comentados, na esperança de que quando estiverem analisando-os, tenham menos dificuldade para entendê-lo. Há casos também em que o pedido parte de uma regra estabelecida para toda a equipe de desenvolvimento. Essas solicitações podem, de certa forma, vir a desestimular o desenvolvedor a criar códigos que deixam claro seu objetivo, já que deverão utilizar comentários para auxiliar no entendimento. Considere o código da "

A exibição deste artigo foi interrompida :(
Este post está disponível para assinantes MVP

 
Você precisa estar logado para dar um feedback. Clique aqui para efetuar o login
Receba nossas novidades
Ficou com alguma dúvida?