มันเป็นการปฏิบัติที่ไม่ถูกต้องหรือไม่ที่จะให้ไฟล์สองไฟล์ที่แตกต่างกันมากโดยมีจุดประสงค์ทั่วไปเหมือนกันในชื่อเดียวกัน

มันเป็นวิธีปฏิบัติที่ไม่ถูกต้องหรือไม่ที่จะให้สองไฟล์ที่แตกต่างกันมากโดยมีจุดประสงค์ทั่วไปเหมือนกันในชื่อเดียวกัน

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

ฉันต้องการทำให้ชื่อไฟล์ของฉันสั้นและไฟล์ทั้งสองมีวัตถุประสงค์ทั่วไปเหมือนกันโดยไม่เหมือนกัน ฉันไม่แน่ใจว่าสิ่งนี้จะถือเป็นแนวปฏิบัติที่ไม่ดีในสภาพแวดล้อมการเขียนโปรแกรมมืออาชีพหรือไม่ ฉันต้องการทราบว่าวิธีปฏิบัติที่ดีที่สุดคืออะไรในสถานการณ์นี้

อีกทางหนึ่งด้วยค่าใช้จ่ายของชื่อสั้นฉันสามารถใช้:

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

พิจารณาอัตราส่วนต้นทุน / ผลประโยชน์ของสองตัวเลือกของคุณ:

1. การใช้ชื่อเดิมซ้ำจะทำให้เกิดความสับสนหรือตั้งชื่อความขัดแย้งหรือไม่ อาจไม่ได้เนื่องจากอยู่ในโฟลเดอร์ที่แตกต่างกัน ชื่อ "player_stats / generator.js" เทียบเท่ากับ "player_stats_generator.js" อย่างไรก็ตามหากคุณเห็นว่าในอนาคตมีเหตุผลที่จะรวมไฟล์ js ของคุณไว้ในไดเรกทอรีเดียว (การปรับใช้หรือไม่ฉันไม่ทราบ) นี่ควรเป็นตัวบ่งชี้ที่ดีที่จะให้ชื่อเฉพาะ

2. การใช้ชื่อที่ยาวขึ้นจะเกี่ยวข้องกับการพิมพ์จากภายนอกหรือไม่? อาจจะไม่. ไม่เพียงทำชื่อไฟล์การเติมข้อความอัตโนมัติ JS IDEs จำนวนมากในโครงการให้กับคุณ แต่ยังเป็นส่วนหนึ่งของรหัสที่อาจเขียนได้ไม่เกินหนึ่งครั้งต่อไฟล์ รหัสที่พิมพ์บ่อยมากคือคลาสและฟังก์ชันภายในไฟล์ js และสิ่งเหล่านั้น (หวังว่า) จะไม่ขัดแย้งกัน

3. เมื่อทำการดีบักข้อมูลประเภทใดที่คุณได้รับเกี่ยวกับข้อผิดพลาด หากรายงานข้อผิดพลาดที่พบบ่อยที่สุดคือ "ข้อผิดพลาดในบรรทัดที่ 34 <filename.js>" ให้พิจารณาตั้งชื่อเฉพาะให้พวกเขาเนื่องจากได้รับข้อผิดพลาดในเครื่องกำเนิดไฟฟ้าเพียงแค่จากนั้นพยายามที่จะทำนายผ่านบริบทซึ่งกำเนิดอาจเป็นเรื่องยุ่งยาก

เช่นเดียวกับในทางปฏิบัติหาก IDE ของคุณแสดงชื่อไฟล์ในแท็บหากคุณใช้ชื่อเดียวกันสำหรับแต่ละไฟล์คุณจะพบกับแท็บที่แสดงชื่อเดียวกันทั้งหมด นั่นอาจเป็นเรื่องที่น่ารำคาญมาก โครงการหนึ่งที่ฉันเข้ารับการบำรุงรักษามีปัญหานั้นและมันเป็นความเจ็บปวดครั้งใหญ่ที่เปิดแท็บได้ 15 แท็บครึ่งหนึ่งของชื่อไฟล์เดียวกัน

ดังนั้น ... ใช้ชื่อที่สื่อความหมายมากกว่านี้

มีปัจจัยการตัดสินใจที่ชัดเจนที่นี่: DRY (อย่าทำซ้ำตัวเอง)

ชื่อไฟล์ทุกชื่อไม่จำเป็นต้องแตกต่างกัน นั่นคือสิ่งที่เส้นทางที่มีการ คุณนึกภาพออกว่ามีไฟล์ระบบหรือไฟล์โปรแกรมต่างกันกี่ไฟล์ในคอมพิวเตอร์ของคุณ? เกิดอะไรขึ้นถ้าแต่ละคนต้องมีชื่อที่ไม่ซ้ำกัน? ในบางจุดเราเพิ่งจะทำให้ชื่อไฟล์เป็นสำเนาของเส้นทาง

หากคำอธิบายที่ดีที่สุดของไฟล์จาวาสคริปต์ในบริบทของclient_scripts > app > player_statsมันคือเส้นทางของมันควรจะเป็นgeneratorclient_scripts/app/player_stats/generator.js

คำถามนี้เป็นคำถามที่programmers.stackexchange.com/questions/ 250481 นอกจากนี้ยังมีserverfault.com/questions/ 250481 250481เป็นสิ่งหนึ่งในบริบทของคำถามของโปรแกรมเมอร์และอย่างอื่นในบริบทของคำถาม Server Fault

เส้นทาง (หรือ URL) นั้นดีเพราะเป็นตัวระบุที่ซ้อนกัน มาใช้มันกันเถอะ :)

ใช้ชื่อที่สื่อความหมายเหนือชื่อสั้น ๆ เว้นแต่ว่ามันจะเป็นค่าคงที่ทางคณิตศาสตร์หรือตัวแปรลูปที่อนุสัญญาของภาษาที่เป็นที่นิยมใช้ชื่อสั้น ๆ ตัวอย่างเช่นหากคุณเรียกตัวแปร "pi" และให้ค่าที่ถูกต้องเหมาะสมของ pi ดังนั้นชื่อจะดีและทำให้เกิดจุดข้าม ในทางกลับกันถ้าคุณมีเครื่องกำเนิดไฟฟ้าที่สร้างเงื่อนไขของซีรีส์เทย์เลอร์สำหรับ Pi และรวมเข้าด้วยกันเป็นไพประมาณคุณต้องการเรียกมันว่า "taylorPiGenerator หรือคล้ายกัน

ชื่อที่ดีในขณะนี้ช่วยประหยัดเวลาในการปรับโครงสร้างใหม่ในภายหลังหรือแม้แต่ข้อผิดพลาดที่ยิ่งใหญ่ในภายหลัง

หนังสือClean CodeและCode Complete มีรายละเอียดมากพอ ๆ กับ whys และที่ ๆ การตั้งชื่อที่ดี แต่มันไม่ได้เป็นแหล่งเดียว

ขึ้นอยู่กับเทคโนโลยีที่คุณใช้งาน ชื่อควรระบุรายการและเส้นทางควรระบุบริบท ฉันยอมรับการตั้งชื่อที่ดีเป็นสิ่งสำคัญ แต่เฮ้เส้นทางเป็นชื่อด้วย แต่จากมุมมองของภาคปฏิบัติหากคุณกำลังใช้บางอย่างเช่นจาวาสคริปต์คงเป็นเรื่องที่ดีกว่าถ้าจะเก็บชื่อที่แม่นยำสำหรับรายการสุดท้าย หากคุณกำลังทำงานกับเครื่องมือที่คำนึงถึงเรื่องนี้เช่นPythonวิธีที่แนะนำคือการใช้ชื่อเดียวกันกับพา ธ อื่น (โมดูลเนมสเปซ) ถ้าคุณดูที่Javaคุณจะได้พบกับชั้นเรียนที่มีชื่อเดียวกันและแพ็คเกจอื่น เราสามารถก้าวไปอีกขั้นและพูดว่าวิธีการนั้นมีชื่อว่าการกระทำในบริบทของคลาสและเรามีวิธีการตั้งชื่อเหมือนกันในชั้นเรียนที่แตกต่างกันซึ่งตัวเองสามารถตั้งชื่อเดียวกัน แต่วางไว้ในแพ็คเกจที่แตกต่างกัน The Zen of Pythonพูดว่า:

Namespaces เป็นหนึ่งในแนวคิดที่ยอดเยี่ยม - ลองทำสิ่งเหล่านี้ให้มากขึ้น!

แต่จาวาสคริปต์นั้นมีนิสัยและข้อได้เปรียบดังนั้นฉันขอแนะนำให้คุณใช้ชื่ออื่น (แม้ว่าไฟล์จะอยู่ในเส้นทางที่ต่างกัน) นอกจากนี้คุณอาจค้นหารูปแบบโมดูลใน javascript ซึ่งสามารถช่วยคุณเขียนรหัสสะอาด:

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

คุณสามารถมีเค้กของคุณและกินมันด้วย