S01 – Atividade de Aprendizagem: Convenções de Nomenclatura
Visão Geral
Ao trabalhar na web, vários fatores, como navegador, protocolo(s), sistema operacional, idiomas, etc., podem influenciar o funcionamento dos arquivos. Embora muitos deles estejam fora do seu controle, você pode manter seu trabalho consistente e gerenciável por meio de convenções padrão de nomenclatura de arquivos e pastas.
"Quando você está construindo um site, precisa reunir os arquivos em uma estrutura sensata no seu computador local, garantir que eles possam se comunicar entre si e fazer com que todo o seu conteúdo tenha uma aparência correta antes de finalmente enviá-los para um servidor." – MDN (Mozilla Developer Network Reference)
Preparação
- As convenções de nomenclatura de arquivos e pastas descritas nesta aula 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.
Observe que a maioria das organizações tem suas próprias orientações e práticas recomendadas de gerenciamento de arquivos, incluindo convenções para nomear arquivos, pastas e outros fluxos de trabalho. Essas convenções podem variar de uma organização para outra.
- Revise: Lidando com Arquivos – MDN
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, como
produtos.htmlPlataformas 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 de arquivos e pastas. Use hifens em vez disso, como
design-documento.htmlOs espaços são manipulados de forma inconsistente pelos usuários, portanto, 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 pela sintaxe "
%20", que é confusa. Evite usar espaços e, em vez disso, se quiser criar espaço visual, use hifens. - NÃO use caracteres especiais, por exemplo,
<,>, \, /, #, ?, !Caracteres especiais geralmente significam coisas específicas para computadores, então não os use na nomeação de arquivos e pastas.
- Nomes de arquivos e pastas devem ser tão curtos e significativos (semânticos) quanto
possível. Por exemplo, use
cenario-inverno-sm.pngem vez deimagem13-v123523imagensdevidadegalhosquebrados w200x200.pngNomes curtos evitam que você, outros desenvolvedores e visitantes do site tenham que lembrar de nomes longos e complicados para arquivos e pastas. Quando significativos, os nomes também podem ajudar a prever a finalidade ou a natureza do conteúdo do arquivo ou da pasta.
- Nesta classe, os nomes de pasta padrão para nossos sites/subpastas são:
- estilos – Pastas com este nome contêm arquivos CSS.
- imagens – Pastas com este nome contêm imagens.
- scripts – Pastas com este nome contêm arquivos JavaScript.