WDD 231: Desenvolvimento Frontend para Web I

S01 - Atividade de Aprendizagem: Convenções de Nomenclatura

Visão Geral

Ao trabalhar na web, há vários fatores que afetam a operação dos arquivos — o navegador, o(s) protocolo(s), o sistema operacional, o(s) idioma(s), etc. Embora muitas dessas coisas estejam fora do seu controle, há medidas que você pode tomar manter tudo consistente e gerenciável usando convenções padrão de nomenclatura de arquivos e pastas.

Preparação

As convenções de nomenclatura de arquivos e pastas serão consideradas regras de "melhores práticas" para este curso. Essas regras devem ser implementadas a todos os arquivos e pastas criados no seu trabalho do curso.

Convenções de Nomenclatura

Espera-se que você siga essas convenções de nomenclatura ao longo do curso.

• Use toda a sintaxe em letras minúsculas, por exemplo, produtos.html

  Plataformas e sistemas lidam com diferenciação de maiúsculas e minúsculas de forma diferente. A diferenciação entre maiúsculas e minúsculas é um conceito importante a ser entendido ao gerenciar arquivos e pastas.

• NÃO use espaços em nomes. Em vez disso, use traços, por exemplo, documento-de-design.html
  Os espaços são interpretados incorretamente pelos agentes de usuário. Não os utilize. O Protocolo de Transferência de Hipertexto (HTTP ou Hypertext Transfer Protocol, em inglês) ignora espaços, exceto em nomes de arquivos. Em nomes de arquivos, ele substitui um espaço pelo símbolo "%20". Isso faz com que os URLs ficam difíceis de entender, além de poder confundir os usuários que acessam o site. Portanto, evite usar espaços. Em vez disso, se você tiver que criar um espaço visual, use hifens/travessões.
• NÃO use caracteres especiais em nomes, por exemplo, <,>, \, /, #, ?, !
  Caracteres especiais geralmente significam coisas específicas para computadores, então evite usá-los na nomeação de arquivos e pastas.
• NÃO use acentuação em nomes, por exemplo, solicitação.html deve ser escrito solicitacao.html
  Nomes de diretórios e arquivos com acentos podem não ser lidos corretamente em sistemas operacionais, navegadores ou servidores diferentes. Caracteres acentuados podem ser convertidos para sequências de caracteres ilegíveis para usuários de outros idiomas.
• Use nomes que sejam tão curtos e significativos (semânticos) quanto possível, por exemplo, cenario-inverno-sm.png é melhor que imagem13-v123523imagensdevidadegalhosquebrados w200x200.png
  Nomes curtos e significativos evitam que você, outros desenvolvedores e visitantes do site tenham que lembrar de nomes longos e complicados para arquivos e pastas. Quando significativos, eles também ajudam a prever a finalidade ou a natureza do conteúdo do arquivo ou pasta ao trabalhar com esses arquivos ou pastas.
• Nesta classe, os nomes de pasta padrão para os sites/subpastas são:
  • estilos – Pastas com este nome contêm os arquivos CSS.
  • imagens – Pastas com este nome contêm as imagens.
  • scripts – Pastas com este nome contêm os arquivos JavaScript.
  Essas pastas podem ter nomes diferentes, como css em vez de estilos, ou js em vez de scripts, mas o mais importante é que os nomes sejam coerentes com o conteúdo das pastas e que você siga as convenções de nomenclatura para garantir consistência e facilitar a colaboração com outros desenvolvedores.