Artigos Canal Mais Boas práticas para escrita de métodos, funções e procedimentos - Revista Engenharia de Software Magazine 40 - Parte 2
Demais posts desta série:
Boas práticas para escrita de métodos, funções e procedimentos – Parte 1
Boas práticas para escrita de métodos, funções e procedimentos – Parte 3
Boas práticas para escrita de métodos, funções e procedimentos – Parte 4
Boas práticas para escrita de métodos, funções e procedimentos – Parte 5
Boas práticas para escrita de métodos, funções e procedimentos – Parte 6
Boas práticas para escrita de métodos, funções e procedimentos – Parte 7
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 tópico é interessante uma vez que provê conhecimento ao desenvolvedor sobre como transformar códigos considerados ruins em bons códigos demonstrando através de exemplos práticos as 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. Esta tarefa será possível graças ao conhecimento adquirido 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

A escrita de código de forma sequencial, isto é, código que é executado de cima para baixo, da primeira linha até a última, restringe uma ação a ser executada somente depois da sua anterior, não considerando estruturas condicionais que fornecem mais de um caminho. As funções, métodos e procedimentos permitem que o código seja organizado em sequência, mas também em blocos, o que traz como benefício a organização do código em estruturas que podem ser executadas em qualquer ponto de uma classe ou arquivo de código fonte quando invocados.

Mediante a importância das estruturas como métodos, funções e procedimentos em uma aplicação, é necessário que eles sejam escritos de forma limpa e mantidos limpos durante todo o ciclo de vida do software.

Todas as teorias que serão abordadas neste artigo contribuirão para uma melhora efetiva na qualidade e legibilidade do código fonte, mas além das técnicas sobre código limpo, outros recursos se fazem importantes, que são as técnicas de refatoração de código. As teorias sobre código limpo não prevêem uma forma controlada de modificar o código dos métodos, funções e procedimentos como as técnicas de refatoração de código (FOWLER, 2004), portanto a sugestão para que o sucesso seja obtido nessa tarefa é a utilização de refatorações em alguns casos específicos. Quando necessárias, elas serão destacadas, bem como onde aprender mais sobre elas.

Como dito anteriormente, os métodos, funções e procedimentos são estruturas de dados que permitem que tarefas sejam organizadas em blocos e executadas quando necessário. É fato também que todo desenvolvedor conhece os tipos de funções, métodos e procedimentos existentes que são, no caso dos métodos, estruturas que possuem um moderador de acesso (privado, público e protegido, entre outros), um tipo de dados de retorno (inteiro, string, void, entre outros), um nome para o método e uma lista de parâmetros, que pode ser vazia. Alguns métodos possuem um retorno de alguma informação, e outros não, como os que utilizam void como tipo de retorno.

Cada um dos tipos de métodos citados aqui, e também as funções e procedimentos, possuem suas particularidades. Nesse sentido, o objetivo deste artigo é apresentar as teorias sobre código limpo, relativo a funções, que proporcionarão ao desenvolvedor a capacidade de criar estruturas limpas. Os assuntos que serão abordados na seção Funções permitirão ao desenvolvedor criar ou modificar métodos, procedimentos e funções utilizando nomes significativos, isto é, que deixem clara a intenção da estrutura. Outros pontos que receberão destaque neste artigo são referentes ao tamanho das estruturas, ao corpo dos métodos e aos seus objetivos. Além disso, serão abordadas em detalhes todas as teorias que envolvem a definição de bons parâmetros e os riscos das muitas responsabilidades em uma única estrutura.

...
Quer ler esse conteúdo completo? Tenha acesso completo