Melhores Práticas de Nomenclatura: Pastas, Arquivos e Código [RESOLVIDO]

tipoff
(usa Nenhuma)

Enviado em 19/11/2024 - 18:50h

Cara, depende muito do projeto.

Já peguei projeto legado que misturava camelCase, snake_case, e PascalCase. Uma zona.

Em projetos novos, prefiro utilizar camelCase. A exceção é quando estou criando um projeto em Python, costumo usar mais snake_case por conta das funções nativas já seguirem nesse padrão.

Em se tratando de constantes e variáveis de ambiente, costumo usar snake_case em uppercase. Por exemplo: DB_HOST, ACCESS_KEY, etc. Isso reflete o padrão já estabelecido para variáveis de ambiente em sistemas unix.

Buckminster
(usa Debian)

Enviado em 22/11/2024 - 20:19h

https://raw.githubusercontent.com/php/php-src/master/CODING_STANDARDS.md

https://www.php.net/manual/pt_BR/language.variables.basics.php

https://www.php.net/manual/pt_BR/userlandnaming.rules.php

https://www.javascript.com/learn/variables

https://developer.mozilla.org/en-US/docs/Web/JavaScript

https://cloud.google.com/apis/design/naming_convention?hl=pt-br

Essa é uma boa prática que você usa:
Pastas: nome-da-pasta
Arquivos: nome_do_arquivo

A maioria das linguagens de programação são em Inglês, mas depende se você nomeia as variáveis, arquivos, pastas, etc, em inglês ou em Português.
Os nomes devem ser legíveis e entendíveis, pois se depois de um ano você relê teu código, você deve entender e, vamos dizer assim, se achar no código pelos nomes das variáveis, pastas, funções, arquivos, etc.
Em relação aos nomes em si (não ao formato) crie seu próprio padrão como, por exemplo, dê o nome óbvio que designa o arquivo sendo que, pelo nome, você identifica o arquivo: conexao.php, index.php, cad_usuario.php, del_usuario.js, etc.
Em scripts e comandos, a nomenclatura clara é essencial para a legibilidade e manutenção do código. Usar nomes de variáveis e funções que descrevam sua finalidade ajuda outros desenvolvedores (ou você mesmo no futuro) a entender rapidamente o que cada parte do código faz. Por exemplo, uma função chamada calcular_media é muito mais intuitiva do que uma chamada funcao1. Um arquivo chamado backup_diario.sh é mais informativo do que um nome genérico como script1.sh.
No Linux, por exemplo, as regras de nomenclatura incluem a utilização de caracteres alfanuméricos, sublinhados e hífens, evitando espaços e caracteres especiais.
Nos links acima tem padrões e sugestões de nomenclatura, aí você fuça lá e encontra mais coisas.
Vá sempre no site oficial da linguagem que você utiliza, caso estiver programando em Python vá no site oficial, em Javascript, em PHP, C, etc, sempre tem os padrões e sugestões de nomenclaturas.


_________________________________________________________
Always listen the Buck!
Enquanto o cursor estiver pulsando, há vida!