Boas pr�ticas para escrita de m�todos, fun��es e procedimentos � Revista Engenharia de Software Magazine 41

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 2
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 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."

[...] continue lendo...

Boas pr�ticas para escrita de m�todos, fun��es e procedimentos � Revista Engenharia de Software Magazine 41 - Parte 3

Artigos relacionados