Desenvolvimento Código Aberto

Estilo de programação é um conjunto de regras ou orientações utilizadas ao escrever o código-fonte em um programa de computador. Afirma-se frequentemente que, após um estilo de programação especial, este irá ajudar os programadores a ler e compreender o código-fonte em conformidade com o estilo, e ajudar a evitar a introdução de erros.

A obra clássica sobre o assunto foi os elementos do estilo de programação, escrito na década de 1970, e ilustrado com exemplos do Fortran e PL/I línguas predominantes na época.

O modelo de programação usado em um programa em particular pode ser derivado a partir das convenções de codificação de uma empresa ou qualquer outra instituição de computação, bem como as preferências do autor do código. Estilos de programação muitas vezes são projetados para uma linguagem de programação específica (ou família de línguas): estilo considerado bom em código fonte C pode não ser apropriado para o código fonte BASIC, e assim por diante. No entanto, algumas regras são comumente aplicadas para muitas línguas.

Regra #1 – Usar bons nomes (significativos):

// Ruim - nomes não intuitivos
String a1;
int a2;
double b;

// Nomes intuitivos
// primeiro nome inicia em minúsculo
// segundo nome em maiúsculo

String primeiroNome;
String sobreNome;
int temperatura;

Regra #2 – Use Identação

public static void main (String[] arguments) {
    int x = 5
    x = x * x;
    if (x > 20) {
       System.out.println(x + "  é maior que 20.");
    }

    double y = 3.4;
}

Regra#3 – Use espaço em branco

// Difícil de ler a expressão

double cel=(fahr*42.0/(13.0-7.0));

// Coloque espaço em branco em expressões complexas
// fácil de ler a expressão

double cel = ( fahr * 42.0 / (13.0 -7.0) );

Regra#4 – Use linhas em branco

// Linhas em branco aumenta a legibilidade

public static void main (String[] arguments) {

    int x = 5
    x = x * x;

    if (x > 20) {
       System.out.println(x + " é maior que 20.");
    }

    double y = 3.4;
}

// Código sem legibilidade

public static void main (String[] arguments) {
int x = 5; x = x * x;
if (x > 20) {
System.out.println(x + " é maior que 20."); }
double y = 3.4;
}

Regra#5 – Não duplique testes (if)

// Teste duplicado
// se o pagamento base é menor que 8
// e as horas trabalhadas menor que 60
// o ultimo else if está duplicado

if (pagamentoBase < 8.0)
 { ... }
else if (horas > 60)
{ ... }
else if (pagamentoBase>= 8.0 && horas <= 60)
{ ... }

// Teste correto
if (pagamentoBase < 8.0)
 { ...}
 else if (horas > 60)
 {...}
 else
 { ...}

Mais informações sobre este assunto você pode encontrar neste PDF da universidade de Princeton:

Programming and Program Style (C):
http://www.cs.princeton.edu/courses/archive/spr11/cos217/lectures/07Style.pdf

A instrução return termina a execução do método em que aparece e devolve o controle para o método de chamada. Ele também pode retornar um valor opcional. Se o método é um tipo de vazio, a instrução de retorno pode ser omitido.

Em C++ e Python a terminologia correta é função em vez de método apesar de terem a mesma funcionalidade.

Java

public class metodos
 {
// Metodo para tipos de Frete
  public static String tipofrete (int frete)
  {
      String menssagem= "";
   if (frete == 0)  menssagem = "CIF - Frete a pago pelo fornecedor";
   if (frete == 1) menssagem = "Fob - frete a cargo do consumidor";
   return menssagem;
}

      public static void main(String[] args)
 {

// Executa o metodo
       System.out.println(tipofrete(0));
       System.out.println(tipofrete(1));

}

}

C++

#include "stdafx.h"
#include <iostream>
#include <string></pre>
using namespace std;

// Metodo para tipos de Frete
    string tipofrete(int frete)
 {
  string menssagem = "";
  if (frete == 0) menssagem = "CIF - Frete a pago pelo fornecedor";
  if (frete == 1) menssagem = "Fob - frete a cargo do consumidor";
  return menssagem;
 }

int _tmain(int argc, _TCHAR* argv[]) {

  // Executa o metodo
  cout << tipofrete(0)  <<"\n";
  cout << tipofrete(1) << "\n";
  system("pause");
return 0;

}

C#

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;</pre>
namespace ConsoleApplication35 {

class Program
     {
         // Metodo para tipos de Frete
         public static String tipofrete(int frete)
         {
             String menssagem = "";
             if (frete == 0) menssagem = "CIF - Frete a pago pelo fornecedor";
             if (frete == 1) menssagem = "Fob - frete a cargo do consumidor";
             return menssagem;
         }

          static void Main(string[] args)

          {
            // executa o metodo
             Console.WriteLine(tipofrete(0));
             Console.WriteLine(tipofrete(1));
             Console.ReadKey();
          }
     }
 }

Python (Linux)

#!/usr/bin/env python
# -*- coding: latin-1 -*-
# Desenvolvimento Aberto
# retorno.py

# Importa OS
import os

# Limpa a tela
os.system("clear")

# Cria função de frete
 def tipofrete(frete):
     menssagem= "";
     if (frete == 0):
         menssagem = "CIF - Frete a pago pelo fornecedor";
     if (frete == 1):
         menssagem = "Fob - frete a cargo do consumidor";
     return menssagem;

# Mostra tipo do frete
print tipofrete(0)
print tipofrete(1)

O método é um elemento que representa uma chamada de procedimento para um objeto. Sendo um elemento de uma classe, utilizado na programação orientada a objetos(Orientação a objetos). Métodos tem por finalidade realizar uma tarefa. Eles são análogos às funções em C, C++ e Python e sub-rotinas em pascal. Métodos geralmente correspondem à uma ação do objeto.

Exemplo:

Bidu é uma instância da classe Cachorro, portanto tem habilidade para latir, implementada através do método Latir(). Um método em uma classe é apenas uma definição. A ação só ocorre quando o método é invocado através do objeto, no caso Bidu. Dentro do programa, a utilização de um método deve afetar apenas um objeto em particular; Todos os cachorros podem latir, mas você quer que apenas o objeto Bidu dê o latido. Normalmente, uma classe possui diversos métodos, que no caso da classe Cachorro poderiam ser sente(), coma() e morda().

Em C++ e Python a terminologia correta é função em vez de método apesar de terem a mesma funcionalidade.

Java

public class metodos {

// Metodo para imprimir uma linha
  public static void novalinha()
  {
      // Cria uma linha vazia
      System.out.println("");
  }

   // Metodo para imprimir três linhas
  public static void treslinhas()
  {
      // Executa metodo para pular linha
     novalinha(); novalinha(); novalinha();
  }

public static void main(String[] args) {

       // Executa o metodo
       System.out.println("Linha numero 1");
       treslinhas();
       System.out.println("Linha numero 2");

   }
}

C++

#include "stdafx.h"
#include <iostream>

using namespace std;

  // Metodo para imprimir uma linha
  static void novalinha()
 {
   // Cria uma linha vazia
   cout << "\n";
 }

   // Metodo para imprimir três linhas
 static void treslinhas()
 {
    // Executa metodo para pular linha
    novalinha(); novalinha(); novalinha();
 }

 int _tmain(int argc, _TCHAR* argv[])
 {
    // Executa o metodo
    cout << "Linha numero 1\n";
    treslinhas();
    cout << "Linha numero 2\n";
    system("pause");
    return 0;
 }

C#

 using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;

namespace ConsoleApplication35 {

class Program {

         // Metodo para imprimir uma linha
         public static void novalinha()
         {
            Console.WriteLine("");
         }

         // Metodo para imprimir três linhas
         public static void treslinhas()
         {
            novalinha(); novalinha(); novalinha();
         }

         static void Main(string[] args)
         {
            // executa o metodo
            Console.WriteLine("Linha numero 1");
            treslinhas();
            Console.WriteLine("Linha numero 2");
            Console.ReadKey();
           }
     }
 }

Python (Linux)

#!/usr/bin/env python
# -*- coding: latin-1 -*-
# Desenvolvimento Aberto
# metodos.py

# Importa OS
import os

# Limpa a tela
os.system("clear")

# Cria função para pular uma linha
def novalinha():
        print ""

# Cria Função para  pular tres linhas
def treslinhas():
    novalinha()
    novalinha()
    novalinha()

# executa a função para pular 3 linhas
print "Linha numero 1"
treslinhas()
print "Linha numero 2"

Imagine o seguinte cenário:

Uma fabrica de software que esta há vários anos no mercado e desenvolve aplicativos para Windows em 5 linguagens de programação  diferentes entre elas: C++, Java, C#, Delphi e Python. A fabrica conta com 5 equipes com 10 desenvolvedores cada. Acontece que ao longo dos anos cada sistema sempre teve sua própria autonomia de desenvolvimento havendo muitos códigos redundantes entre elas. O novo CEO da empresa resolveu  projetar um framework* único em C++  pretendendo poupar horas de programação de código entre as equipes.

O gerente de projeto responsável pelo framework* baixa no gerenciador de código fonte o seguinte código enviado pelo  líder da equipe de Python:

 cidade = raw_imput("Entre uma cidade")
 while cidade[-1]==" " :
         cidade = cidade[:-1]
 temp=raw_input("Entre uma temperatura in farenheit: ")
 temp = float (temp)
 temp = (temp - 32.0) * (100.0/180.0)
 temp = round(temp,3)
 temp = srt(temp)
 print "Na "+cidade+" é "+temp+ " graus celsius!"

Há um monte de problemas com este código fonte. Um rápido exame e nenhuma informação é revelada sobre qual dos nossos funcionários escreveu este código. Qual é o nome do arquivo? O que ele faz? À primeira vista, estamos perdidos. Este código iria receber uma nota 10?

O código fonte é devolvido e reformulado por uma desenvolvedora da equipe,  seguindo as melhores praticas de programação de software e retorna assim:

#Alicia P. Hacker
#Fah_para_Celsius.py

#coleta a cidade
cidade = raw_imput("Entre uma cidade")

#trunca espaços em branco
while cidade[-1]==" " :
cidade = cidade[:-1]

#coleta a temperatura
temp=raw_input("Entre uma temperatura in farenheit: ")

#converte string para float
temp = float (temp)

#Converte graus farenheith para graus celsius
temp = (temp - 32.0) * (100.0/180.0)

#Arredonda para três casas decimais
temp = round(temp,3)

#reconverte string para concatenação
temp = srt(temp)

#imprime o resultado
print "Na "+cidade+" são "+ temp + " graus celsius!"

Podemos ver claramente o nome de Alicia e o nome do seu arquivo. Além disso, ela comentou bem as linhas do seu programa. Este código iria receber uma nota 10.

Você deve ser como Alicia! Você deve comentar onde você puder colocar comentários que explicam o que está fazendo, e se você está fazendo algo complicado ou original não se esqueça de explicar bem.

Uma boa meta é ter um comentário a cada 1-4 linhas de código. Certifique-se de não só documentar o que o código está fazendo, mas, quando você começa a escrever um código mais avançado, você deve documentar o que foi deixado intencionalmente de fora, otimizado, testados e rejeitados, etc, basicamente, qualquer decisão de projeto que você faz.

Uma atividade simples que muitas fabricas de software ignoram  mas que possibilita o entendimento de códigos complicados com mais rapidez , encontrar facilmente os bugs, melhorar a comunicação entre equipes de desenvolvimento, facilidade de visualização além de embelezar o código(code beautifier).

* Framework é uma abstração que une códigos comuns entre vários projetos de software provendo uma funcionalidade genérica