-1

Padrões de Programação PEAR (parte 2)

criado por Marcelo Pereira Fonseca da Silva em 27/02/2004 11:11am
Para declarar funções existe um padrão que é como segue:

No manual fala sobre a convenção "one true brace" para uso em funções

<?php
function minha_funcao($arg1, $arg2 = '')
{
    if (condição) {
        // comandos aqui;
    }
    return $val;
}
?>

O último ponto que este artigo da série irá tratar é sobre as tags PHP e Comentários

Sobre as tags PHP como visto nos dois artigos da série, é usado sempre <?php para abrir o código PHP

Isso vem também de uma regrinha da PEAR que fala para usar sempre <?php e ?>
para delimitar o código PHP, NUNCA usar <? e ?>, e falam também que isso é
um requisito sobre pacotes que serão incorporados à PEAR.

Os comentários são um ponto especial na programação, o ponto mais importante.

Eles seguem as especificações do PHPDoc http://www.phpdoc.org/
que são similares ao JavaDoc.

É interessante ressaltar somente que você é encorajado a usar // para comentários
de linha e /* */ (no padrão do PHPDoc) para comentários de bloco e você é
fortemente desencorajado a usar # para comentários de linha no estilo perl.

Exemplo:

<?php
Class teste {

    /**
     * É muito importante documentar meu código
     * por isso estou fazendo da maneira correta.
     */
    function() 
    {

    }
}
?>

Existem algumas "tags" precedidas por "@" que são padrões do PHPDoc
para documentar corretamente é interessante usá-las.

Abraços,

Marcelo Pereira Fonseca da Silva

Comentários:

Mostrando 1 - 10 de 22 comentários
Ótimo artigo, esses padrões irão ajudar a organizar meus códigos, vlw... obrigado pelas luz... apresentareis aos programadores da equipe aqui...

abraço...
14/09/2007 10:10am (~14 anos atrás)

Cara, muito bom o artigo...
Fora essas criticas sem sentido, tem que explicar para eles que padrão é bem diferente de regra.

Seguir o padrão da PEAR acredito ser a melhor escolha, por ser a melhor biblioteca para php.

[]'s
13/07/2006 12:46pm (~15 anos atrás)

Eu sigo algumas regras do padrão PEAR até por questões de estética do código, o código fica mais limpo e bem mais fácil de se entender. Porém, cada programador tem sua regra e forma de programar do jeito que achar melhor, a PEAR setou um padrão adotado pela grande maioria e não por todos, alguns até tentam se adaptar mas quase nunca consegue ou demora um certo tempo. Minha opinião é que cada programador deve utilizar seu próprio metodo, com tanto que se obtenha o resultado esperado no final.

Abraços!
17/06/2005 9:08am (~16 anos atrás)

... stress.

Eu particularmente uso o SciTE para editar meus PHP's. Eu configurei ele para que quando eu teclar o TAB ele use quatro espaços. Simples huh? :)

[z]
25/03/2004 2:19pm (~17 anos atrás)

não existe minha regra
o tema do artigo não é sobre REGRAS DO MARCELO

SIGA OU MORRE!

ninguém nunca falou isso aqui, dos 15 comentários todos foram produtivos

Se você não concorda, bom, tudo bem
Só que o artigo volto a dizer..

não é e nunca será sobre regras que eu quero impor.. eu não quero impor nada..

Isso são padrões da PEAR que EVENTUALMENTE é ACONSELHÁVEL usar

o caps lock nas duas palavras acima é para dar ênfase no intuito do artigo

sei que muitos detestam a PEAR, outros gostam da PEAR mas não usam os coding standards dela.. o conteúdo é só pra dar uma chance do pessoal conhecer alternativas para melhorar seus códigos (quem quiser, obviamente)
10/03/2004 2:15pm (~17 anos atrás)

João K. disse:
"eu que não vou ficar alterando meu editor toda hora"

a sua regra também deveria se aplicar a isso.
10/03/2004 2:03pm (~17 anos atrás)

Para chamada de funcoes e estruturas de controle if, else, switch, while etc..

a PEAR poe no manual o

if (condicao) {
//codigo
}

para definicao de funcao, ou seja:

function lalala($lerolero)
{

}

isso vale também para classes

espero ter ajudado
08/03/2004 9:59am (~17 anos atrás)

Ígor Bonadio disse:
Uma dúvida: tb está certo usar assim:
if (condição)
{
//codigo
}
ou deve ser assim:
if (condição){
//codigo
}
E isso serve tb para funções?
07/03/2004 7:38pm (~17 anos atrás)

a questão não é o melhor estilo
a questão era achar um comum
já que é homologado pela php.net

é triste ver comentários contra
não porque eu ou a PEAR ou seja la quem for quer impor algo.

Mas porque quem sofre depois é o próprio programador, que sempre precisa trabalhar em cima de scripts assim..

o uso de comentario com tab particularmente acho que não funciona.

eu que não vou ficar alterando meu editor toda hora
07/03/2004 9:14am (~17 anos atrás)

João K. disse:
Eu uso TAB sem dó nem piedade huahuahua. E quero ver quem me convence do contrário.

uma maneira de contornar o problema é só acrescentar um comentário no topo do script informando quanto um TAB vale de espaço.
exemplo

// 1 TAB = 4 blank space


Programming Style Tips
http://area51.phpbb.com/docs/guide-standards.html
http://www.cs.sonoma.edu/~tiawatts/C++Style.html
http://www.possibility.com/Cpp/CppCodingStandard.html
http://geosoft.no/style.html



Realmente no fim é uma Guerra Santa para dizer o melhor ESTILO....
07/03/2004 1:39am (~17 anos atrás)

Novo Comentário:

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