Início > Códigos-Fonte, Dicas, Programação > Dicas de etiqueta para programadores

Dicas de etiqueta para programadores

Quando começamos a programar, não ligamos muito para como escrevemos o código e sim, se ele funciona.

Porém, quando ganhamos maturidade, aprendemos que não escrevemos os códigos-fonte somente para nós mesmos, mas também para os que vão estudá-los ou aprimorá-los. Para isso, devemos seguir regras básicas de etiqueta, que visam tornar o código-fonte mais inteligível.

1. Dê nomes sugestivos às variáveis

Não existe nada mais chato que quando você vai verificar um código-fonte e se depara com isso:

ERRADO
var
	a, b, c, d : real;
	e : String;

Procure dar nomes sugestivos às variáveis, para que você possa lembrar o significado delas posteriormente.

CERTO
var
	nota1, nota2, nota3, media : real;
	nomeAluno : String;

2. Agrupe as variáveis

As variáveis de mesmo tipo podem ser agrupadas, pois isto diminui o tamanho do seu código e o deixa mais claro.

ERRADO
var
	nota1 : real;
	nota2 : real;
	nota3 : real;
	nomeAluno : String;
	media : real;
CERTO
var
	nota1, nota2, nota3, media : real;
	nomeAluno : String;
3. Indente o código

Um código sem indentação é algo quase indecifrável. A indentação é algo fundamental na prática de programação, pois ajuda a organizar o seu código-fonte. A indentação consiste em criar tabulações em determinados blocos de códigos. Os padrões mais usados são de 3 ou 4 espaços por tabulação.

ERRADO
program Soma2Num;
var
numero1, numero2, soma : integer;
begin
write('Numero 1 :');
readln(numero1);
write('Numero 2 :');
readln(numero2);
soma := numero1 + numero2;
writeln('Soma = ', soma);
end.

Além de indentar o código, é aconselhável deixar alguns espaços em branco separando alguns comandos. Estes espaços também contribuem para uma melhor visualização do código.

CERTO
program Soma2Num;
var
	numero1, numero2, soma : integer;

begin
	write('Numero 1 :');
	readln(numero1);

	write('Numero 2 :');
	readln(numero2);

	soma := numero1 + numero2;

	writeln('Soma = ', soma);
end.
4. Utilize um padrão para a nomeação

Nós devemos escolher um padrão para como nomear as variáveis, procedimentos, funções, constantes, etc.

Na linguagem Java, por exemplo, as classes começam com letras maiúsculas e no singular. Já as variáveis e métodos (funções e procedimentos, em Pascal) começam com letra minúscula e se tiver mais de uma palavra, as seguintes começarão com letra maiúscula. Por fim, as constantes devem ser escritas em caixa alta.

  • Classes:
public class Olamundo{
}
  • Variáveis e métodos (procedimentos e funções):
int idade;
String nomeAluno;
public void falaOlaMundo{
System.out.println("Olá Mundo!");
  • Constantes:
  • PI = 3.1415;
    TAXA_MENSAL = 0.15;
ERRADO
procedure dizolamundo();
var
	FALA : String;
begin
	FALA := 'Ola Mundo!';
	writeln(FALA);
end;
CERTO
procedure dizOlaMundo();
var
	fala : String;
begin
	fala := 'Ola Mundo!';
	writeln(fala);
end;
5. Abuse dos operadores

Os operadores ++, –, +=, -=, *=, /=, etc. são muito úteis, pois eles diminuem o tamanho de seu código e o torna mais enxuto.
Infelismente, a linguagem Pascal não dá suporte a estes operadores.

ERRADO
soma = soma + 1;
mult = mult * 2;
cont = cont + 1;
CERTO
soma += 1;
mult *= 1;
cont ++;
6. Use comentários

Os comentários são essenciais para que o programador possa entender o que determinado procedimento faz, ou para que serve uma determinada variável.

ERRADO
function area(lado : real) : real;
begin
	area := lado * lado;
end;

Colocar comentários como //fim if, //fim while, etc. ajuda o programador a saber qual bloco ele está terminando. Esta dica é muito útil em programas maiores.

CERTO
//Esta função recebe o valor do lado de um quadrado e retorna sua área.
function area(lado : real) : real;
begin
	area := lado * lado;
end; //fim area

Se você ficou com alguma dúvida, ou tem uma sugestão para melhorar este post, deixe um comentário.

Acesse o novo endereço do Olá Mundo!: http://ola-mundo.com

  1. Camila
    11 de maio de 2010 às 16:24

    Isso tudo chama-se de ‘endentação’?

    • 11 de maio de 2010 às 16:50

      Não, Camila. Endentação, indentação ou identação referem-se a mesma coisa. Consiste em criar recuos no texto, fazendo com que ele fique mais claro e organizado. Todas estas dicas não dizem respeito a endentação, apenas a 3ª.

  2. 11 de maio de 2010 às 16:59

    Parabéns! Ótimo post Luiz.

    Camila, identação é os espaçamentos ou tabulações que damos dentro de um código, para facilitar sua legibilidade.

    um exemplo em algoritmos:

    se (2 = 2) entao
    ….escreva(“dois é igual a dois”)

    os . (pontos) são fictícios aqui, foram utilizados apenas para o aprendizado.

    em python:

    if (2 == 2):
    ….print “dois é igual a dois”

    em python, você é obrigado a identar o código, ou o condicional não funcionaria, mas em qualquer outra linguagem, como o post do Luiz Augusto fala, é uma questão de ética identar e comentar o código.

    =)

    • 11 de maio de 2010 às 17:04

      Muito obrigado Bruno! Espero que os programadores iniciantes façam bom proveito.

  3. Camila
    11 de maio de 2010 às 17:40

    Acho que ficou mais claro para mim, : ).
    Obrigada ao Bruno e Luiz.

  1. No trackbacks yet.

Deixe uma resposta

Preencha os seus dados abaixo ou clique em um ícone para log in:

Logotipo do WordPress.com

Você está comentando utilizando sua conta WordPress.com. Sair / Alterar )

Imagem do Twitter

Você está comentando utilizando sua conta Twitter. Sair / Alterar )

Foto do Facebook

Você está comentando utilizando sua conta Facebook. Sair / Alterar )

Foto do Google+

Você está comentando utilizando sua conta Google+. Sair / Alterar )

Conectando a %s

%d blogueiros gostam disto: