-2
Algumas boas técnicas de programação
Nomes de funções, classes, variáveis e constantes
Isso não é algo tãããão essencial assim, mas eu já li artigos mostrando alguns padrões de programação que falam sobre nomes de variaveis, funções e classes. Isso vai de cada pessoa, mas eu achei bem legal o chamado "padrão" para nomes.
Variáveis e funções:
- 1 palavra: todas com letra minúscula. Ex: $nome; $idade; erro(); mensagem()
- 2 palavras ou mais: primeira palavra com letra minúscula e a primeira letra de cada palavra com letras maiúsculas. Ex: $remetenteNome; $nomeDoPai; getCode(); msgErro();
Classes:
- 1 palavra: Primeira letra maiúscula. Ex: Carro; Formulario;
- 2 palavras: Primeira letra de cada palavra maiúsculas. Ex: MySql; BancoDeDados;
Constantes:
- 1 palavra com todas as letras maiúsculas. Ex: TITULO; NOME;
Como eu já disse isso vai de cada pessoa. Há quem prefira utilizar os _ para separar palavras, como $meu_nome; etc... eu, particularmente, prefiro utilizar $meuCarro.
Essas são apenas algumas técnicas de uma boa programação. Seguindo essas 3 regrinhas qualquer um e você mesmo poderá entender seus códigos no futuro. Melhor do que escrever algo hoje e daqui a 1 ano ter que ficar quebrando a cabeça para descobrir o que tal função faz, sendo que foi você mesmo que escreveu!
Espero que esse artigo ajude aos que estão iniciando (principalmente) e àqueles que já estão programando.
Isso não é algo tãããão essencial assim, mas eu já li artigos mostrando alguns padrões de programação que falam sobre nomes de variaveis, funções e classes. Isso vai de cada pessoa, mas eu achei bem legal o chamado "padrão" para nomes.
Variáveis e funções:
- 1 palavra: todas com letra minúscula. Ex: $nome; $idade; erro(); mensagem()
- 2 palavras ou mais: primeira palavra com letra minúscula e a primeira letra de cada palavra com letras maiúsculas. Ex: $remetenteNome; $nomeDoPai; getCode(); msgErro();
Classes:
- 1 palavra: Primeira letra maiúscula. Ex: Carro; Formulario;
- 2 palavras: Primeira letra de cada palavra maiúsculas. Ex: MySql; BancoDeDados;
Constantes:
- 1 palavra com todas as letras maiúsculas. Ex: TITULO; NOME;
Como eu já disse isso vai de cada pessoa. Há quem prefira utilizar os _ para separar palavras, como $meu_nome; etc... eu, particularmente, prefiro utilizar $meuCarro.
Essas são apenas algumas técnicas de uma boa programação. Seguindo essas 3 regrinhas qualquer um e você mesmo poderá entender seus códigos no futuro. Melhor do que escrever algo hoje e daqui a 1 ano ter que ficar quebrando a cabeça para descobrir o que tal função faz, sendo que foi você mesmo que escreveu!
Espero que esse artigo ajude aos que estão iniciando (principalmente) e àqueles que já estão programando.
gostarai de saber como faz no php enviar um email com varios anexos juntos
04/08/2005 9:00am
(~19 anos atrás)
Não acho isso, de suma importancia ...
A visto que o PHP, e uma linguagem muito ampla com muito caminhos para ser fazer o mesmo trabalho.
Lógico que um padrão ajuda, mas do que adianata um padrão, se quem o lê não enetede "bulufas"(presupondo que seje a iniciantes).
E que para quem trabalha com isso o esquema e enteder o por que que as coisas acontecem não como ele são escrita...
se eu ver isso:
if ($Variavel){ return; }
ou isso
if $vArIaVeL
return;
eu vou entder da mesma forma ... o importante é você sabe o que faz/significa não a forma como ela esta disponta nos códigos...
Mas Não deixa de ser plausivel fazer o esquema bonito arrumado e Limpo...
A visto que o PHP, e uma linguagem muito ampla com muito caminhos para ser fazer o mesmo trabalho.
Lógico que um padrão ajuda, mas do que adianata um padrão, se quem o lê não enetede "bulufas"(presupondo que seje a iniciantes).
E que para quem trabalha com isso o esquema e enteder o por que que as coisas acontecem não como ele são escrita...
se eu ver isso:
if ($Variavel){ return; }
ou isso
if $vArIaVeL
return;
eu vou entder da mesma forma ... o importante é você sabe o que faz/significa não a forma como ela esta disponta nos códigos...
Mas Não deixa de ser plausivel fazer o esquema bonito arrumado e Limpo...
26/02/2004 9:19am
(~21 anos atrás)
Amigos,
A formação do programador conta muito na hora em que ele cria um código com clareza ou não. Como o PHP nasceu num meio acadêmico sem as devidas formalidades de um curso superior (embora eu já saiba que alguns cursos superiores têm pelo menos incentivado seus alunos a praticarem o PHP), isso fez com que cada programador desenvolvesse seu próprio estilo, o que até certo ponto é bastante saudável. Adotar padrões faz parte de um amadurecimento profissional de cada um. Tive o privilégio de ter como mestres no PHP, os renomados Tim Converse e Joyce Park através do livro PHP4 A Bíblia. Nele aprendi o padrão proposto pela PEAR sem nem ter conhecimento de sua existência. Simplesmente ele estava lá, adotado pelos mestres e seguido à risca pelos aplicados alunos. Seria importante que todos procurassem aprender de tais fontes, mesmos os iniciados por outros meios.
A formação do programador conta muito na hora em que ele cria um código com clareza ou não. Como o PHP nasceu num meio acadêmico sem as devidas formalidades de um curso superior (embora eu já saiba que alguns cursos superiores têm pelo menos incentivado seus alunos a praticarem o PHP), isso fez com que cada programador desenvolvesse seu próprio estilo, o que até certo ponto é bastante saudável. Adotar padrões faz parte de um amadurecimento profissional de cada um. Tive o privilégio de ter como mestres no PHP, os renomados Tim Converse e Joyce Park através do livro PHP4 A Bíblia. Nele aprendi o padrão proposto pela PEAR sem nem ter conhecimento de sua existência. Simplesmente ele estava lá, adotado pelos mestres e seguido à risca pelos aplicados alunos. Seria importante que todos procurassem aprender de tais fontes, mesmos os iniciados por outros meios.
16/02/2004 2:05pm
(~21 anos atrás)
Se eu não me engano a "PEAR" foi criada meio que com este propósito de fazer uma coisa unificada, organizada com relação ao PHP
os standards da PEAR são maravilhosos :)
o André que me apresentou :P
dai sempre venho usando agora
e a duplinha PEAR/PHP Documentor faz sucesso.. muita coisa também tem no PHP Documentor é verdade.. todo o esquema de "tags" vem de lá que eles montaram pra não gerar confusao na hora de documentar que é bom dar uma olhada também
os standards da PEAR são maravilhosos :)
o André que me apresentou :P
dai sempre venho usando agora
e a duplinha PEAR/PHP Documentor faz sucesso.. muita coisa também tem no PHP Documentor é verdade.. todo o esquema de "tags" vem de lá que eles montaram pra não gerar confusao na hora de documentar que é bom dar uma olhada também
28/01/2004 10:33am
(~21 anos atrás)
Bem, eu acredito que um padrão único seja muito difícil de formar.. acho que o ponto mais importante é deixar o código legível e ponto.
Eu prefiro usar
if (condicao) {
----codigo
} else {
----codigo
}
As linhas são referentes ao espaço. A questão das variaveis dentro de string eu concordo.. tem que concatenar, até mesmo por que, se você usa um editor que colore as palavras "especiais", vai ficar muita mais facil encontrar uma variavel assim. ;)
E acho que um programador que venha a ler meu código, bem comentado e nesse formato, vai entender, mesmo que use outro modo.
Eu prefiro usar
if (condicao) {
----codigo
} else {
----codigo
}
As linhas são referentes ao espaço. A questão das variaveis dentro de string eu concordo.. tem que concatenar, até mesmo por que, se você usa um editor que colore as palavras "especiais", vai ficar muita mais facil encontrar uma variavel assim. ;)
E acho que um programador que venha a ler meu código, bem comentado e nesse formato, vai entender, mesmo que use outro modo.
27/01/2004 9:16am
(~21 anos atrás)
Eu não conhecia o coding standarts da PEAR.. realmente nota 10. Mas, não é especificamente da PEAR, mas sim, do phpDocumentor.
http://phpdoc.org/docs/HTMLSmartyConverter/default/phpDocumentor/tutorial_phpDocumentor.pkg.html
A partir de agora todos meus códigos vão seguir esse padrão, ainda mais que seguindo o mesmo, o meu código é auto documentado pelo phpDocumentor.
http://phpdocu.sourceforge.net/
Vale a pena ver.
http://phpdoc.org/docs/HTMLSmartyConverter/default/phpDocumentor/tutorial_phpDocumentor.pkg.html
A partir de agora todos meus códigos vão seguir esse padrão, ainda mais que seguindo o mesmo, o meu código é auto documentado pelo phpDocumentor.
http://phpdocu.sourceforge.net/
Vale a pena ver.
23/01/2004 9:33am
(~21 anos atrás)
Marcelo, valeu pela dica, nunca tinha prestado atenção nessa parte da documentação e os padrões de lá são bem consistentes, achei legal, vale a pena olhar: http://pear.php.net/manual/en/standards.php
22/01/2004 4:13pm
(~21 anos atrás)
Só pra complementar muita coisa
que foi escrita no artigo
Além de ir contra o que o pessoal da PEAR tenta pregar e até é interessante o nível de organização que eles tentam fazer (algumas classes não o fazem)
De qualquer forma o artigo está remando contra tudo que eles falam
Sei lá.. eu ainda fico com o esquema da PEAR
que foi escrita no artigo
Além de ir contra o que o pessoal da PEAR tenta pregar e até é interessante o nível de organização que eles tentam fazer (algumas classes não o fazem)
De qualquer forma o artigo está remando contra tudo que eles falam
Sei lá.. eu ainda fico com o esquema da PEAR
21/01/2004 5:42am
(~21 anos atrás)
Muita gente esqueceu dos coding standards que o pessoal da PEAR dá a dica de como padronizar o código PHP, um deles é sobre estruturas de comentários
não vou sobrecarregar o post com isso
aos interessados,
http://pear.php.net
não vou sobrecarregar o post com isso
aos interessados,
http://pear.php.net
21/01/2004 5:40am
(~21 anos atrás)
Comentário é o primeiro passo da documentação do seu código, mas sobre o estilo, para mais de uma linha, use /* */. E para quem programa em Java, tbm vale:
/**
*
*
*/
Melhor do que aquele monte de barra que deixa seu código sujo e cheio de bytes sem motivo...
/**
*
*
*/
Melhor do que aquele monte de barra que deixa seu código sujo e cheio de bytes sem motivo...
20/01/2004 6:14pm
(~21 anos atrás)