ti-enxame.com

PHP, HTML, Javascript e boas práticas de escrita

Percebi que tenho que escrever uma especificação de convenção sobre HTML, JavaScript e codificação PHP para mim e minha equipe.

Em desenvolvimento web, assim como em C++, sou definitivamente um fã de indentação e comentários.

No entanto, muitas vezes em meu trabalho encontro código HTML + JavaScript + PHP que de repente me traz dor de cabeça.

Estou tentando tornar meu código legível, mas o que parece ser melhor para mim (recuar e comentar) parece não fascinar meus colegas de equipe, então eu queria saber se existe uma prática recomendada ou pelo menos compartilhada ao escrever "híbrido "documentos exatamente como as páginas da web de hoje, que a cada dia se tornam mais complexas.

Estou ciente do fato de que provavelmente é da natureza do código das páginas da Web de hoje ser um pouco complicado, mas me pergunto se já existe uma boa convenção sobre esses aspectos.

10
Federico Zancan

Algumas regras gerais que sigo:

Geral

  • Os recuos são 4 espaços.
  • Recuar novos níveis
  • Os comentários têm <~ 80 caracteres do nível de indentação. Se estou em dois níveis (8 espaços), isso significa que a parada do cursor será em torno de 88 caracteres.
  • Use comentários de várias linhas. Eu prefiro o visual, porém este é um subjetivo ponto.
  • Comente agora, em vez de depois, quando não tiver ideia do que está acontecendo.
  • colchetes estilo Allman . É mais limpo e mais legível. Subjetivo.

JavaScript

  • Use uma biblioteca. O jQuery em particular é muito bom. Elimina todas as dores de cabeça entre navegadores.
  • Entenda que IDs são para elementos específicos, classes são para estilos. IDs não devem ser usados ​​mais do que uma vez por página e eles terão ganchos específicos anexados a eles. Use classes para coisas como navegação.
  • Nossa fonte em métodos. É tentador colocar todo o código na chamada bind, no entanto, colocá-lo em sua própria função aumentará a flexibilidade do seu código.
  • Use funções em vez de evals. Isso significa setTimeout(function(){ /* Do something */ }, 1000); em vez de setTimeout('doSomething', 1000);
  • Use variáveis ​​locais com var.

HTML

  • Marcação semântica. Use tags apropriadas. Não coloque <br /> está lá para adicionar espaço, ajustar margens e regras CSS.
  • Todas as tags são minúsculas .
  • Todas as tags devem terminar com uma tag de fechamento ou ser de fechamento automático .
  • Faça uso de classes para layouts semelhantes. Tenha algumas classes predefinidas como hide, clear, error, etc.
  • Tudo (scripts incluídos) deve ir em <head>. Preocupe-se em otimizar (movimentar as coisas) quando houver um problema.
  • Folhas de estilo externas e fonte JavaScript é obrigatório a menos que seja específico da página.

PHP

  • Frameworks são bons, eu recomendo CodeIgniter.
  • Se você não quiser usar um framework, tente usar a última versão de PHP possível. (Isso significa 5.3).
  • Use includes a seu favor.
  • Limpe as injeções ou use instruções preparadas.
  • Execute se as verificações nos valores de proteção contra falhas preconcebidos.

    $logged_in = false;
    if(check_user($user))
    {
         $logged_in = true;
         $user = load_user($_SESSION);
    }
    
  • Conheça a diferença entre aspas simples e duplas. Use aspas simples quando possível.
  • Não imite HTML.
19
Josh K

Existem algumas leituras para inspiração:

  • Zend Framework - estilo de codificação php : Lista de práticas como escrever código php sustentável (formatação de arquivo PHP, convenções de nomenclatura, estilo de codificação: matrizes, string, classe, método, por exemplo).
  • Google - guia de estilo de código : Lista de práticas de como escrever código javascript sustentável (Regras: Constantes, Ponto e vírgula, Função aninhada ..., Estilo de codificação: Nomenclatura, Escopo, String, Campos de visibilidade etc.).
3
tomascejka

A maneira mais fácil de codificar um aplicativo da web php é certamente misturar tudo junto. Você rapidamente acabará com uma bagunça insustentável se fizer as coisas dessa maneira.

Aqui estão algumas boas práticas:

1) Coloque seu JavaScript no <head> de um documento (ou, melhor ainda, em arquivos separados que são referenciados no head). Aprenda a vincular ouvintes de evento em um evento document.onload, em vez de espalhá-los em seu html. (Melhor ainda, aprenda a usar uma estrutura como Jquery; isso tornará seu JavaScript muito, muito mais bonito).

2) Procure padrões de projeto como MVC. Você deseja separar sua lógica de negócios, escrita em PHP, de seu HTML, tanto quanto possível. O ideal é que você acabe usando uma linguagem de modelagem agradável para reunir suas páginas HTML; no mínimo, o PHP em seu HTML deve ser conciso - principalmente chamando variáveis ​​e percorrendo listas que são construídas em outro lugar.

3) Comentários, recuo ... essas coisas são apenas práticas básicas de programação. Eu tendo a deixar minha linha ultrapassar 80 caracteres quando estou escrevendo HTML, só porque a linguagem é muito prolixa, mas essa é a única prática tradicional que você deve deixar passar - se o resto da equipe está sendo desleixado, eles precisam absorvê-lo e tomar forma.

2
Patch

Mantenha os 3 separados. O código menos sustentável com o qual eu lido é sempre quando há algum PHP que está ecoando muito HTML e JavaScript, provavelmente com algum SQL usado para uma boa medida.

Manter todos eles separados tornará o código muito mais fácil de manter e também tornará as coisas muito mais simplificadas se você tiver pessoas trabalhando em diferentes partes do aplicativo, como um designer que só precisa trabalhar com HTML/CSS.

2
GSto

Aqui estão algumas dicas:

Javascript: use var ao inicializar variáveis.

HTML: inclui scripts na parte inferior do arquivo para que sejam carregados por último.

PHP: Divida os arquivos. Não coloque todas as suas classes em um arquivo, como você não faria no desenvolvimento normal de C++. Comente tanto quanto possível e também escreva o propósito de suas funções/classes.

0
Harry