Padrões de Nomenclatura

From COREPHP

Jump to: navigation, search

Para melhora qualidade, manutenabilidade e compreensão do código, são necessários seguir algumas regras em relação à nomenclatura de Classes, atributos, métodos, Interfaces e Controles.

Ficam então estabelecidos os seguintes padrões:

Contents

1 - Classes

A definição da Classe deverá sempre ser iniciada de Maiúscula seguido por minúsculas. Em casos de nomes compostos, o segundo nome também deverá iniciar em Maiúscula seguido de minúsculas. Não devem ser utilizados _ para separar os nomes compostos! Isto é aplicável tanto as Classes de Modelo, quanto às de Controle e Interface.

Ex: Pessoa e PessoaFisica

Adendo 1: Devido à migração dos objetos para a biblioteca [POP], a Classe deverá ser precedida sempre de P, ficando então PPessoa, PPessoaFisica, etc, para indicar que a mesma é uma classe do tipo POP.

1.a - Atributos

Devem ser sempre escritos em minúsculas, conforme padrão da POP. Podem ou não fazer referência ao tipo que contém. Podem ou não conter _. Devem ser óbvias. Não podem ser utilizados nomes sem sentidos nem genéricos demais. O nome tem que ter sentido. O nome do campo na Interface deverá ser o mesmo que o do atributo na Classe do Modelo!

Ex: dt_nascimento para data de nascimento está correto. asdf1234 para qualquer coisa não diz nada.

1.b - Métodos

Devem ser iniciadas em minúscula e se forem compostos devem ter a segunda palavra iniciada por maiúscula e verbo no infinitivo.

Ex: $classe->pegarAtributo();

2 - Objetos

Objetos são instanciamentos de Classes, mas não são a Classe em si. Assim, Objetos devem seguir a mesma regra de nomenclatura de variáveis e atributos, sendo sempre escrito em minúsculas.

Ex: $pf = new PPessoaFisica();

3 - Funções

Devem ser iniciadas em minúscula e se forem compostos devem ter a segunda palavra iniciada por maiúscula.

Ex: emailConfirmacaoDFP();

4 - Variáveis

Devem ser sempre escritas em minúsculas. Podem ou não fazer referência ao tipo que contém. Podem ou não conter _. Devem ser óbvias. Não podem ser utilizados nomes sem sentidos nem genéricos demais. O nome tem que ter sentido, exceto quando for uma variável utilizada para contador.

Ex: $contador_paginas - nome óbvio. $i, $j - só quando utilizados dentro de loops.

This page was last modified on 10 July 2009, at 14:12. This page has been accessed 262 times.