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

10

Percebi que preciso escrever uma especificação de convenção sobre códigos HTML, JavaScript e PHP para mim e minha equipe.

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

No entanto, muitas vezes, no meu trabalho, encontro código HTML + JavaScript + PHP, que de repente traz a 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 fiquei pensando se há uma boa ou pelo menos compartilhada boa prática ao escrever "híbrido" "documentos como as páginas da web de hoje, que dia a dia se tornam cada vez 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.

— Federico Zancan
fonte

19

Algumas regras gerais que sigo:

Geral

Recuos são 4 espaços.
Recuar novos níveis
Os comentários são <~ 80 caracteres do nível de recuo. Se eu estiver em dois níveis (8 espaços), isso significa que a parada do cursor terá cerca de 88 caracteres.
Use comentários de várias linhas. Eu prefiro o visual, no entanto, este é um ponto subjetivo .
Comente agora, mais tarde, quando não tiver ideia do que está acontecendo.
Aparelhos de estilo Allman . É mais limpo e mais legível. Subjetivo .

Javascript

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

HTML

Marcação semântica. Use etiquetas apropriadas. Não coloque <br />lá para adicionar espaço, ajustar margens e regras de CSS.
Todas as tags estão em minúsculas .
Todas as tags devem terminar com uma tag de fechamento ou fechar automaticamente .
Faça uso de classes para o layout que é semelhante. Tem um par de classes predefinidas como hide, clear, error, etc.
Tudo (scripts incluídos) deve entrar <head>. Preocupe-se em otimizar (movimentar coisas) quando apresentar um problema.
Folhas de estilo externas e fonte JavaScript são obrigatórias, a menos que sejam específicas da página.

PHP

Estruturas são boas, eu recomendo o CodeIgniter.
Se você não quiser usar uma estrutura, tente usar a versão mais recente possível do PHP. (Isso significa 5.3).
Use includespara sua vantagem.
Injeções claras ou use instruções preparadas.

Realize se verifica valores pré-concebidos de segurança contra falhas.

$logged_in = false;
if(check_user($user))
{
     $logged_in = true;
     $user = load_user($_SESSION);
}

Saiba a diferença entre aspas simples e duplas. Use aspas simples, quando possível.
Não faça eco de HTML.

— Josh K
fonte

4

Excelente lista. Para o PHP, eu adicionaria 1) usar modelos, não misture php e html (em aplicativos, pelo menos) 2) não use inclui () como chamadas de função 3) mantenha o máximo de código possível fora do escopo global.

— GrandmasterB

quem recomenda CodeIgniter e jQuery perde qualquer integridade aos meus olhos.

— mefisto

4

@teresko: Você condena sem apresentar razões ou alternativas.

— Josh K

+1. Uma lista de pontos discutíveis e discutíveis, mas uma lista muito boa, no entanto.

— haylem

O jQuery elimina todas as dores de cabeça no navegador?

— James Adam

3

Há algumas leituras para inspiração:

Zend Framework - estilo de codificação php : lista de práticas para escrever código php que pode ser mantido (formatação de arquivo PHP, convenções de nomenclatura, estilo de codificação: matrizes, cadeias, classes, métodos, por exemplo).
Guia de estilo de código do Google : lista de práticas de como escrever código javascript que pode ser mantido (Regras: Constans, Ponto-e-vírgula, Função aninhada ..., Estilo de codificação: campos Nomeação, Escopo, String, Visibilidade etc.).

— tomascejka
fonte

você se importaria de explicar mais sobre o que esses recursos fazem e por que os recomenda como resposta à pergunta? "Link-só responde" não são muito bem-vindos no Stack Câmbio

— mosquito

11

@gnat edição / resposta correta

— tomascejka

2

Mantenha os 3 separados. O código menos sustentável que eu trato é sempre quando há algum PHP que ecoa muito HTML e JavaScript, provavelmente com algum SQL rodado por uma boa medida.

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

— GSto
fonte

2

A maneira mais fácil de codificar um aplicativo web php é certamente misturar tudo. Você acaba rapidamente 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 mencionados no cabeçalho). Aprenda a vincular ouvintes de eventos em um evento document.onload, em vez de espalhá-los pelo seu html. (Melhor ainda, aprenda a usar uma estrutura como o Jquery; isso tornará seu JavaScript muito, muito mais bonito).

2) Procure padrões de design como o MVC. Você deseja separar sua lógica de negócios, escrita em PHP, do seu HTML, tanto quanto possível. Idealmente, você acaba usando uma bela linguagem de modelagem para montar 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 criadas em outros lugares.

3) Comentários, recuando ... essas coisas são apenas práticas recomendadas básicas de programação. Costumo deixar meu comprimento de linha acima de 80 caracteres quando escrevo HTML, apenas porque a linguagem é muito detalhada, mas essa é a única prática tradicional que você deve deixar passar - se o restante da equipe estiver desleixado, eles precisam sugar e moldar.

— Fragmento
fonte

Bom comentário! Existe um erro de digitação: "Coloque seu JavaScript no de um documento"

— DL

Ops. Obrigado. (Esqueceu-se de codificar por colchetes angulares. Silly me.)

— Patch

11

Javascript deve ir no final da sua página por razões de desempenho.

— Toby

0

Aqui estão alguns petiscos:

Javascript: Use varao inicializar variáveis.

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

PHP: Divida os arquivos. Não coloque todas as suas classes em um arquivo, assim como você não faria no desenvolvimento C ++ normal. Comente o máximo possível e também anote o objetivo de suas funções / classes.

— atormentar
fonte

Eu tenho tentado seguir o Guia de estilos do Javascript do Google: google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml

— Fosco