Est-ce une mauvaise pratique de donner le même nom à deux fichiers très différents ayant le même usage général?

Est-ce une mauvaise pratique de donner deux fichiers très différents avec le même objectif général du même nom, en les séparant dans des répertoires différents?

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

Je voudrais garder mes noms de fichiers courts, et les deux fichiers ont le même usage général sans être identiques. Je ne sais pas si cela serait considéré ou non comme une mauvaise pratique dans un environnement de programmation professionnel. J'aimerais savoir quelle est la meilleure pratique dans cette situation.

Alternativement, au détriment de la courte longueur du nom, je pourrais utiliser:

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

Tenez compte du rapport coûts / avantages de vos deux options:

1. La réutilisation du même nom entraînerait-elle de la confusion ou des conflits de dénomination? Probablement pas, car ils se trouvent dans des dossiers différents. Le nom « player_stats / generator.js » équivaut à « player_stats_generator.js ». Cependant, si vous voyez, à l'avenir, une raison de fusionner vos fichiers js dans un seul répertoire (déploiement? Je ne sais pas), alors cela devrait être un bon indicateur pour donner des noms uniques.

2. L'utilisation de noms plus longs impliquerait-elle beaucoup de saisie étrangère? Probablement pas. Non seulement de nombreux noms de fichiers de saisie semi-automatique JS IDE sont-ils dans le projet pour vous, c'est aussi un morceau de code qui n'est probablement écrit - au plus - qu'une fois par fichier. Le code qui est tapé beaucoup sont les classes et fonctions à l' intérieur des fichiers js, et ceux (je l' espère) ne sont pas en conflit.

3. Lors du débogage, quel type d'informations obtenez-vous sur une erreur? Si le rapport de bogue le plus courant est "Erreur à la ligne 34 de <filename.js>", envisagez de leur donner des noms uniques, car recevoir des erreurs dans simplement generator.js et essayer de deviner, à travers le contexte, de quel générateur il s'agit peut être un problème.

De manière pratique, si votre IDE affiche les noms de fichiers dans des onglets, si vous utilisez le même nom pour chaque fichier, vous vous retrouverez avec des onglets qui affichent tous le même nom. Cela peut être très ennuyeux. Un projet que j'ai repris en charge a ce problème, et c'est une douleur majeure d'avoir 15 onglets ouverts, la moitié d'entre eux avec le même nom de fichier.

Alors ... utilisez des noms plus descriptifs.

Il y a un facteur décisif clair ici: SEC (ne vous répétez pas).

Chaque nom de fichier ne doit pas être différent; c'est ce que les chemins sont pour . Pouvez-vous imaginer combien de fichiers système ou programme différents se trouvent sur votre ordinateur? Et si chacun d'entre eux devait avoir un nom unique? À un moment donné, nous faisons simplement du nom de fichier une copie du chemin.

Si la meilleure description d'un fichier Javascript dans le contexte de l' client_scripts > app > player_statsest vraiment generator, son chemin devrait l'être client_scripts/app/player_stats/generator.js.

Cette question se trouve sur programmers.stackexchange.com/questions/ 250481 . Il y a également serverfault.com/questions/ 250481 . 250481c'est une chose dans le contexte des questions des programmeurs, et quelque chose d'autre dans le contexte des questions de panne de serveur.

Les chemins (ou URL) sont agréables car ce sont des identifiants imbriqués. Utilisons-les de cette façon :)

Utilisez toujours des noms descriptifs plutôt que des noms courts, à moins que ce ne soit quelque chose comme une constante mathématique ou une variable de boucle où les conventions du langage en question favorisent les noms courts. Par exemple, si vous appelez une variable "pi" et que ce soit une valeur précise de pi appropriée, alors le nom est bon et fait passer le point. D'un autre côté, si vous avez un générateur qui génère des termes de la série Taylor pour Pi et les additionne pour approximer pi, vous voulez l'appeler quelque chose comme "taylorPiGenerator ou similaire.

Les bons noms font désormais gagner du temps au refactor plus tard ou, pire encore, des erreurs massives plus tard.

Les livres Clean Code et Code Complete entrent dans les moindres détails comme le pourquoi et le comment d'une bonne appellation, mais ils ne sont en aucun cas les seules sources.

Cela dépend de la technologie avec laquelle vous travaillez. Les noms doivent identifier les éléments et les chemins doivent identifier le contexte. Je suis d'accord qu'une bonne dénomination est importante mais bon, les chemins sont aussi des noms. Mais d'un point de vue pratique, si vous utilisez quelque chose comme Javascript, il est probablement préférable de conserver des noms plus précis pour les produits finis. Si vous travaillez avec des outils qui prennent cela en considération, comme Python , la méthode recommandée serait d'utiliser le même nom avec un chemin différent (module, espace de noms). Si vous regardez Java, vous trouverez également des classes du même nom et des packages différents. On pourrait aller plus loin et dire que les méthodes sont nommées actions dans le contexte d'une classe, et nous avons des méthodes nommées de la même manière dans différentes classes, qui elles-mêmes peuvent être nommées de la même façon mais placées dans des packages différents. Le Zen de Python dit:

Espaces de noms sont un klaxonnent grande idée - faisons plus de ceux-là!

Mais javascript a ses bizarreries et ses avantages, je vous recommande donc de choisir des noms différents (même si les fichiers sont dans des chemins différents). Vous pouvez également rechercher le modèle de module en javascript qui pourrait vous aider à écrire du code plus propre:

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

Vous pourriez avoir votre gâteau et le manger aussi.