Páginas

segunda-feira, 13 de outubro de 2008

Convenções de código

Convenções de código são um padrão de codificação que um grupo de programadores decide seguir. Isso inclui nomes de variáveis, de arquivos, identação, comentários, etc. Segundo o site da Sun, as convenções de código são importantes para os programadores por três razões:
  • 80% do custo de desenvolvimento de um software é gasto com manutenção
  • Dificilmente um software é mantido por toda sua vida pelo autor original
  • Convenções de código dão legibilidade ao software
Nas aulas de Linguagem de Programação Comercial eu procuro mostrar ao alunos a importância de usar convenções de código até mesmo em benefício do seu próprio aprendizado. Utilizamos Delphi nessa disciplina e vou documentar aqui o padrão que eu criei no desenvolvimento de meus sistemas e o qual eu os aconselho a utilizarem.
No caso dos componentes eu os nomeio iniciando com duas ou três letras minúsculas abreviando o tipo do componente seguidas de um nome iniciando em maiúscula:
  • Botões (TButton, TBitBtn, TSpeedButton) - iniciam com btn. Exemplo: btnFechar, btnOk, btnCancelar
  • Caixas de texto (TEdit) - iniciam com edt. Exemplo: edNome, edEndereco
  • Caixas combinadas (TComboBox) - iniciam com cbx. Exemplo: cbxCidade, cbxEstado
  • Caixas de lista (TListBox) - iniciam com lb. Exemplo: lbProfissao, lbEscolaridade
  • Rótulos (TLabel) - iniciam com lbl. Exemplo: lblNome, lblEndereco
  • Barra de rolagem (TScrollBar) - iniciam com sb. Exemplo: sbIdade
  • Caixas de verificação (TCheckBox) - iniciam com chx. Exemplo: chxSituacao
  • Menus (TMainMenu, TPopUpMenu) - iniciam com mn. Exemplo: mnPrincipal
  • Formulários (TForm) - iniciam com frm. Exemplo: frmPrincipal
  • Unidades (Unit) - iniciam com u_. Exemplo: u_principal
  • Tabelas (TTable) - iniciam com tb. Exemplo: tbProduto, tbCliente.
  • Fontes de dados (TDataSource) - iniciam com ds. Exemplo: dsProduto, dsCliente.
  • Queries (TQuery) - iniciam com que. Exemplo: queProduto, queCliente.
Além disso procuro identar o código e usar nomes que sugiram a função (a que se destina) de cada variável ou componente.

Nenhum comentário:

 
Creative Commons License
This work by Carlos Alberto P. Araújo is licensed under a Creative Commons Atribuição-Uso não-comercial-Compartilhamento pela mesma licença 3.0 Brasil License.