É uma prática ruim atribuir o mesmo nome a dois arquivos muito diferentes com o mesmo objetivo geral?

É uma má prática atribuir dois arquivos muito diferentes com o mesmo objetivo geral ao mesmo nome, separando-os em diretórios diferentes?

<script src="client_scripts/app/player_stats/generator.js"></script>
<script src="client_scripts/app/coach_settings/generator.js"></script>

Eu gostaria de manter os nomes dos meus arquivos curtos e os dois arquivos têm o mesmo objetivo geral sem serem idênticos. Não tenho certeza se isso seria considerado uma prática ruim em um ambiente de programação profissional. Eu gostaria de saber qual é a melhor prática nessa situação.

Como alternativa, às custas do tamanho curto do nome, eu poderia usar:

<script src="client_scripts/app/player_stats/player_stats_generator.js"></script>
<script src="client_scripts/app/coach_settings/coach_settings_generator.js"></script>

Considere a relação custo / benefício de suas duas opções:

1. Reutilizar o mesmo nome causaria confusão ou conflitos de nome? Provavelmente não, pois estão em pastas diferentes. O nome "player_stats / generator.js" é equivalente a "player_stats_generator.js". No entanto, se você vir, no futuro, um motivo para mesclar seus arquivos js em um único diretório (implantação? Não sei), esse deve ser um bom indicador para fornecer nomes exclusivos.

2. O uso de nomes mais longos envolveria muita digitação estranha? Provavelmente não. Muitos IDs de JS não completam automaticamente nomes de arquivos no projeto para você, mas também é um pedaço de código que provavelmente é escrito apenas - no máximo - uma vez por arquivo. O código que é muito digitado são as classes e funções dentro dos arquivos js, e essas (espero) não conflitam.

3. Ao depurar, que tipo de informação você obtém sobre um erro? Se o relatório de erro mais comum for "Erro na linha 34 de <filename.js>", considere fornecer nomes exclusivos, pois receber erros apenas em generator.js e depois tentar adivinhar, através do contexto, qual gerador ele pode ser um aborrecimento.

Como uma questão prática, se o seu IDE mostrar nomes de arquivos em guias, se você usar o mesmo nome para cada arquivo, você terminará com guias que mostram o mesmo nome. Isso pode ser muito chato. Um projeto que assumi a manutenção tem esse problema, e é muito difícil ter 15 guias abertas, metade delas com o mesmo nome de arquivo.

Então ... use nomes mais descritivos.

Há um fator decisivo claro aqui: DRY (não se repita).

Todo nome de arquivo não precisa ser diferente; é para isso que servem os caminhos . Você pode imaginar quantos arquivos diferentes de sistema ou programa estão no seu computador? E se cada um deles tivesse que ter um nome único? Em algum momento, estamos apenas tornando o nome do arquivo uma cópia do caminho.

Se a melhor descrição de um arquivo Javascript no contexto de client_scripts > app > player_statsrealmente é generator, seu caminho deve ser client_scripts/app/player_stats/generator.js.

Esta pergunta está em programmers.stackexchange.com/questions/ 250481 . Também há serverfault.com/questions/ 250481 . 250481é uma coisa no contexto das perguntas dos programadores e outra no contexto das perguntas de falha do servidor.

Caminhos (ou URLs) são bons porque são identificadores aninhados. Vamos usá-los dessa maneira :)

Sempre use nomes descritivos sobre nomes abreviados, a menos que seja algo como uma constante matemática ou variável de loop, onde as convenções da linguagem em questão favorecem nomes abreviados. Por exemplo, se você chamar uma variável "pi" e tiver algum valor precisamente preciso de pi, o nome será bom e entenderá o ponto. Por outro lado, se você possui um gerador que gera termos da série Taylor para Pi e os adiciona para aproximar o pi, convém chamá-lo de algo como "taylorPiGenerator ou similar.

Agora, bons nomes economizam tempo de refatoração mais tarde ou erros maciços ainda piores mais tarde.

Os livros Código Limpo e Código Completo entram em detalhes consideráveis ​​como os porquês e os motivos da boa nomeação, mas não são de modo algum as únicas fontes.

Depende da tecnologia com a qual você está trabalhando. Os nomes devem identificar itens e os caminhos, o contexto. Concordo que a boa nomeação é importante, mas ei, caminhos também são nomes. Mas, do ponto de vista prático, se você estiver usando algo como Javascript , provavelmente é melhor manter nomes mais precisos para os itens finais. Se você estiver trabalhando com ferramentas que levem isso em consideração, como o Python , a maneira recomendada seria usar o mesmo nome com caminho diferente (módulo, espaço para nome). Se você der uma olhada em Java, você também encontrará classes com o mesmo nome e pacotes diferentes. Pode-se dar um passo adiante e dizer que os métodos são nomeados ações no contexto da classe, e temos métodos nomeados iguais em diferentes classes, que podem ser nomeados iguais, mas colocados em pacotes diferentes. O Zen do Python diz:

Os espaços para nome são uma ótima idéia - vamos fazer mais!

Mas o javascript tem peculiaridades e vantagens, então eu recomendo que você escolha nomes diferentes (mesmo que os arquivos estejam em caminhos diferentes). Além disso, você pode procurar o padrão do módulo em javascript, que pode ajudá-lo a escrever um código mais limpo:

    var playerStatsGenerator = player_stats.Generator();
    var coachSettingsGenerator = coach_settings.Generator();

Você pode comer o seu bolo e comê-lo também.