Uma nomenclatura bem organizada e consistente pode salvar nossa pele quando um projeto toma grandes proporções.

Os problemas mais sérios são os nomes usados nos bancos de dados, coisas como ter um campo com o mesmo nome em várias tabelas, e falta de padrão nos nomes das tabelas e seus registros.

Erros que não devemos cometer

Evitar usar os famosos ‘ID’, ‘NUMREG’ ou outro termo qualquer como chave primária de suas tabelas, menos que seu sistema possua apenas uma tabela, o que é muito improvável. Na hora de criar um relacionamento seu banco de dados pode explodir.

Evite usar tudo com letras maiúsculas, se você trabalha em um ambiente Linux ou derivado já sabe que tudo é “Case Sensitive”, então o minúsculo ou a ordem da primeira letra maiúscula seguida das minúsculas são a melhor opção.

De programador para programador

Vamos tomar como exemplo uma base de dados que contenham 3 tabelas, uma de clientes, uma de vendas e uma de produtos. Os nomes das tabelas sempre começariam com o prefixo ‘tb’ seguido pelo nome, que ficariam tbClientes, tbVendas e tbProdutos.

Ó que coisa simples… mas isso ajuda muito quando você tem que trabalhar no código de sua aplicação, afinal quando você ler tbClientes já sabe que se trata da tabela de clientes, caso contrario, se fosse somente CLIENTES poderia gerar dúvidas pois poderia ser uma variável, uma constante ou qualquer outra coisa menos a tabela…

Em seguida vem o padrão da estrutura interna das tabelas que é outro ponto que devemos sempre tomar muito cuidado. Eu uso como padrão da chave primaria da tabela o prefixo ‘cod’ seguido do nome da tabela, no caso da tabela de clientes seria codCliente.

Os demais campos seguiriam um padrão de prefixos de acordo com a tabela, colocando prefixos de no máximo 3 caracteres, a tabela de clientes poderia ficar assim:

Nomenclaturas de arquivos

Uma boa nomenclatura para os arquivos sempre ajuda na localização e na orientação dentro de suas aplicações. Em geral, quando o programa é grande e trabalhamos muito nele, sabemos com certa facilidade sobre o que procuramos, mas depois que se passa um certo tempo sem colocar a mão naquele sistema, ou mesmo quando já está enorme com muitos arquivos e você com serviço saindo pelo “ladrão”, uma hora a cabeça falha e você fica doido procurando determinado arquivo.

De programador para programador

Em geral, em meus projetos eu uso prefixos nos arquivos de acordo com sua funcionalidades dentro do sistema. Veja um exemplo de como ficaria a árvore de arquivos de um sistema web:

Na pasta Arquivos eu guardo todos os arquivos relativos ao projeto, como rascunhos, anotações e fontes de imagens criadas para o projeto, na pasta home geralmente fica apenas um aruivo, o index. A pasta inc já diz, fica guardando os arquivos que serão incluídos ou usados pelo index que fica na pasta home, a pasta img armazena toas as imagens do projeto.

Os arquivos de inclusão que ficam armazenados na pasta inc também recebem um prefixo com o nome da pasta, por exemplo, inc.Clientes.php.

Essas são dicas simples mas que ao longo do tempo podem fazer a diferença na organização do seu trabalho e que com certeza vão refletir em desempenho, agilidade devido ao fluxo de dados e até com usabilidade devido a organização. (Fluxo de dados e usabilidade que são assuntos para post’s futuros.)

Muitos programadores, por alguma razão, não fazem a documentação de seus programas, como diagramas de classe, UML, modelagens em geral. A maioria faz de cabeça ou rascunham em um pedaço de papel.

Em geral isso não é errado, desde que o programa funcione Mas qualquer anotação em um pedaço de guardanapo pode ser considerado como uma modelagem, mesmo que informal.

Eu confesso que para projetos pequenos eu não faço toda a documentação, mas faço um pequeno esboço do programa (mesmo que em papel) um esboço do banco de dados e seus relacionamentos e diagramas de casos de uso (resumidos) também são muito bons para se organizar as idéias na hora de colocar tudo em funcionamento.

Espero que seja de utilidade para todos pois pra mim isso sempre fez a diferença em meus projetos depois que eu comecei a colocar em pratica. Sucesso a todos!

Eliel de Paula – Analista de sistemas
Elieldepaula[arroba]gmail.com

convert this post to pdf.