Padrões de programação

Olá pessoas,
aqui é seu "querido" Paulo, neste post irei expor alguns conceitos em relação à padronização de programação que acho interessantes e fundamentais para entender o código alheio.

1º Declaração de variáveis:

private $arrayVariavel ; // Comentário sobre a variável.
public $arrayVariavel2; // Comentário sobre a variável.
private protected $useAluno; // Comentário sobre a variável.
public static $useCoordenador; // Comentário sobre a variável.

- É interessante que cada variável seja declarada em uma linha, assim, facilita a visualização e organização do código.

- Nunca se esquecer de declarar a visibilidade da variável, mesmo que seja public.

- Nome de variável começando com minúscula e tendo os demais “sobrenomes” com a primeira letra maiúscula.

Todas as variáveis devem ser comentadas, sem exceção!

2º Declaração de métodos (funções).


/**
* método loginUsuario. (nome do método)
* Efetua a validação de login do usuário . (breve explicação de sua funcionalidade)
*@param $nome = O nome do usuário. (parâmetro utilizado)
*@param $senha = A senha do usuário. (parâmetro utilizado)
*@author Paulo Henrique. (nome de quem fez o método)
*/
private function loginUsuario($nome, $senha){
}


- O comentário inicial é muito importante na hora de desenvolver métodos, pois, é uma espécie de “mini manual” para outros programadores.

- O comentário de métodos e classes deve começar com /** (barra + 2 asteriscos), assim, os compiladores, ao menos os mais modernos, identificam que se trate do “mini manual” do método ou classe, e habilita “campos especiais” para organizar seus comentários, como por exemplo, @param e @author, que representam parâmetros e o nome do autor do método, respectivamente.

- A nomenclatura de parâmetros e método segue o mesmo padrão da declaração de variáveis.


3º Declaração de Classes.

/**
* classe TClasse. (nome do da classe)
* ........................................................ (breve explicação de sua funcionalidade)
*@author Paulo Henrique. (nome de quem fez a classe)
*/
class TClasse{
}


- O comentário de classes deve ser estruturado da mesma maneira que o de métodos.

- A nomenclatura de classes tem suas particularidades, começando pelo prefixo “T”, que é a abreviação de Type, seguindo pelo nome da classe, que diferente de variáveis e métodos começa com letra maiúscula.

4º Estruturação de código.


- Essa questão já é mais complicada, pois, cada um tem suas próprias manias para estruturar um código, mas para mim o importante são os comentários.

- Se cada linha ou linhas mais complicadas estiverem explicadas de uma forma clara e objetiva, não a necessidade que a estruturação seja idêntica.

Bem, é isso, não quero impor a maneira de programar, só acho que seguindo esses conceitos fica simples de chegar a um acordo.

[ ]’s