-2

Algumas boas técnicas de programação

criado por Celso Endo em 20/01/2004 1:02pm
Depois que eu comecei a trabalhar numa empresa de criação de sites percebi o quanto é importante seguir algumas regrinhas básicas para programação.

Imagina que você trabalha numa empresa e você está trabalhando em um projeto grande com mais 3 ou 4 pessoas no mesmo projeto... agora imagina se cada uma dessas pessoas programar de um jeito diferente... como sairia o projeto?! E depois na hora que você tiver que alterar alguma coisa em algum código que outra pessoa escreveu?!

Como senti isso na pele aqui na minha firma, resolvi escrever esse artigo para que as pessoas pensem enquanto estiverem escrevendo os códigos: "Outra pessoa poderá ver... preciso deixar o mais 'legível' possível..." ou então: "E se daqui a 1 ano se eu for mexer nisso denovo eu vou saber o que isso faz?!"

Acho que a primeira regrinha básica são os famosos comentários! Sim!! Comente tudo, menos o óbvio... deixe TUDO muito bem explicado... para funções explique sempre os argumentos que a função irá receber (tipo de argumento), o que a função retorna, o que ela faz, etc... Isso poderá ser muito útil mais pra frente!

Em um arquivo de configurações divida por seções e deixe as seções sempre comentadas. Por exemplo:

////////////////////////////////////////////////////
//
// Banco de dados
//
// Variáveis:
//
// $dbHost - Host para conexão
//
// etc...
////////////////////////////////////////////////////

e assim por diante...
Comentários são essenciais em qualquer código de qualquer linguagem!

Comentários:

Mostrando 1 - 10 de 14 comentários
gostarai de saber como faz no php enviar um email com varios anexos juntos
04/08/2005 9:00am (~11 anos atrás)

Sandro disse:
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...
26/02/2004 9:19am (~12 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.
16/02/2004 2:05pm (~12 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
28/01/2004 10:33am (~13 anos atrás)

Newton Wagner disse:
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.
27/01/2004 9:16am (~13 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.
23/01/2004 9:33am (~13 anos atrás)

Diogo Gomes disse:
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 (~13 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
21/01/2004 5:42am (~13 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
21/01/2004 5:40am (~13 anos atrás)

Diogo Gomes disse:
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...
20/01/2004 6:14pm (~13 anos atrás)

Novo Comentário:

(Você pode usar tags como <b>, <i> ou <code>. URLs serão convertidas para links automaticamente.)