คำถามติดแท็ก naming-conventions

ระเบียบการตั้งชื่อหมายถึงกฎทั่วไปที่ควบคุมชื่อที่กำหนดให้กับการสร้างโปรแกรมมิงเช่นตัวแปรและวิธีการ อนุสัญญาเหล่านี้อำนวยความสะดวกในการอ่านและปรับปรุงความสามารถในการบำรุงรักษาของรหัสโดยบังคับใช้การตั้งชื่อที่สอดคล้องกันระหว่างโมดูลที่แตกต่างกัน

10
แบบแผนการตั้งชื่อ Java ด้วยตัวย่อ [ปิด]
ตามที่เป็นอยู่ในปัจจุบันคำถามนี้ไม่เหมาะสำหรับรูปแบบคำถาม & คำตอบของเรา เราคาดหวังคำตอบที่จะได้รับการสนับสนุนจากข้อเท็จจริงการอ้างอิงหรือความเชี่ยวชาญ แต่คำถามนี้อาจเรียกร้องให้มีการอภิปรายโต้แย้งโต้แย้งหรือการอภิปรายเพิ่มเติม หากคุณรู้สึกว่าคำถามนี้สามารถปรับปรุงและเปิดใหม่ได้โปรดไปที่ศูนย์ช่วยเหลือเพื่อขอคำแนะนำ ปิดให้บริการใน8 ปีที่ผ่านมา ชื่อที่ถูกต้องสำหรับคลาส Java ต่อไปนี้ คืออะไรDVDPlayerหรือDvdPlayer?

12
.htm เทียบกับ. html ไฟล์ตั้งชื่อนามสกุลใดถูกต้องมากขึ้น? [ปิด]
ปิด คำถามนี้เป็นคำถามความคิดเห็นตาม ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบข้อเท็จจริงและการอ้างอิงได้โดยแก้ไขโพสต์นี้ ปิดให้บริการใน5 ปีที่ผ่านมา ปรับปรุงคำถามนี้ ฉันควรเลือกนามสกุลไฟล์ใดสำหรับไฟล์ HTML ของฉัน และทำไม?

6
เหตุใดจึงต้องการขีดคั่นสำหรับตัวเลือก CSS / HTML?
ในอดีตที่ผ่านมาฉันใช้ขีดเส้นใต้เพื่อกำหนดแอตทริบิวต์classและidใน HTML เสมอ ในช่วงไม่กี่ปีที่ผ่านมาฉันเปลี่ยนไปใช้ขีดกลางเป็นส่วนใหญ่เพื่อให้สอดคล้องกับแนวโน้มในชุมชนไม่จำเป็นต้องเป็นเพราะมันสมเหตุสมผลสำหรับฉัน ฉันคิดเสมอว่าเครื่องหมายขีดคั่นมีข้อเสียมากกว่าและฉันไม่เห็นประโยชน์: การเติมโค้ดและการแก้ไข บรรณาธิการส่วนใหญ่ถือว่าเครื่องหมายขีดคั่นเป็นตัวคั่นคำดังนั้นฉันไม่สามารถแท็บผ่านสัญลักษณ์ที่ฉันต้องการ สมมติว่าคลาสคือ " featured-product" ฉันต้องเติมข้อมูลอัตโนมัติ " featured" ป้อนยัติภังค์และกรอก " product" เมื่อใช้เครื่องหมายขีดล่าง " featured_product" จะถือว่าเป็นหนึ่งคำจึงสามารถเติมได้ในขั้นตอนเดียว เช่นเดียวกับการนำทางผ่านเอกสาร การกระโดดโดยใช้คำหรือการดับเบิลคลิกที่ชื่อคลาสนั้นจะถูกใช้โดยใช้เครื่องหมายขีดกลาง (โดยทั่วไปแล้วฉันคิดว่าคลาสและรหัสเป็นโทเค็นดังนั้นจึงไม่มีความหมายสำหรับฉันว่าโทเค็นควรจะแยกได้ง่ายบนยัติภังค์) ความกำกวมกับตัวดำเนินการทางคณิตศาสตร์ การใช้เครื่องหมายขีดคั่นจะแบ่งการเข้าถึงคุณสมบัติของวัตถุให้กับองค์ประกอบแบบฟอร์มใน JavaScript สิ่งนี้เป็นไปได้เฉพาะกับขีดล่าง: form.first_name.value='Stormageddon'; (เป็นที่ยอมรับว่าฉันไม่ได้เข้าถึงองค์ประกอบของแบบฟอร์มด้วยวิธีนี้ แต่เมื่อตัดสินใจในการขีดกลางและขีดเส้นใต้เป็นกฎสากลให้พิจารณาว่าอาจมีใครบางคน) ภาษาอย่างSass (โดยเฉพาะในกรอบเข็มทิศ ) ได้ตัดสินด้วยเครื่องหมายขีดคั่นเป็นมาตรฐานแม้สำหรับชื่อตัวแปร ตอนแรกพวกเขาใช้ขีดเส้นใต้ด้วยเช่นกัน ความจริงที่ว่านี้มีการแยกวิเคราะห์แตกต่างกันที่ฉันแปลก: $list-item-10 $list-item - 10 ความไม่สอดคล้องกับการตั้งชื่อตัวแปรในภาษาต่างๆ ย้อนกลับไปในวันนั้นฉันเคยเขียนunderscored_namesหาตัวแปรใน PHP, ruby, HTML / CSS และ JavaScript นี่สะดวกและสอดคล้องกัน …

10
มีแนวทางการตั้งชื่อสำหรับ REST API หรือไม่ [ปิด]
ปิด คำถามนี้เป็นคำถามความคิดเห็นตาม ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบข้อเท็จจริงและการอ้างอิงได้โดยแก้ไขโพสต์นี้ ปิดให้บริการใน2 ปีที่ผ่านมา ปรับปรุงคำถามนี้ เมื่อสร้าง REST API จะมีแนวทางหรือมาตรฐาน defacto สำหรับการตั้งชื่อการประชุมภายใน API (เช่น: ส่วนประกอบพา ธ ปลายทางของ URL, พารามิเตอร์การสอบถาม) อูฐแคปประจำหรือขีดล่างหรือไม่? คนอื่น ๆ ? ตัวอย่างเช่น: api.service.com/helloWorld/userId/x หรือ api.service.com/hello_world/user_id/x หมายเหตุ: นี่ไม่ใช่คำถามของการออกแบบ RESTful API แต่เป็นแนวทางการตั้งชื่อเพื่อใช้สำหรับส่วนประกอบของพา ธ ในที่สุดและ / หรือพารามิเตอร์สตริงการสืบค้นที่ใช้ แนวทางใดจะได้รับการชื่นชม

7
ข้อตกลงการตั้งชื่อยอดนิยมสำหรับการทดสอบหน่วยมีอะไรบ้าง [ปิด]
ตามที่เป็นอยู่ในปัจจุบันคำถามนี้ไม่เหมาะสำหรับรูปแบบคำถาม & คำตอบของเรา เราคาดหวังคำตอบที่จะได้รับการสนับสนุนจากข้อเท็จจริงการอ้างอิงหรือความเชี่ยวชาญ แต่คำถามนี้อาจเรียกร้องให้มีการอภิปรายโต้แย้งโต้แย้งหรือการอภิปรายเพิ่มเติม หากคุณรู้สึกว่าคำถามนี้สามารถปรับปรุงและเปิดใหม่ได้โปรดไปที่ศูนย์ช่วยเหลือเพื่อขอคำแนะนำ ปิดให้บริการใน7 ปีที่ผ่านมา ทั่วไป ปฏิบัติตามมาตรฐานเดียวกันสำหรับการทดสอบทั้งหมด ชัดเจนเกี่ยวกับสถานะการทดสอบแต่ละครั้ง มีความเฉพาะเจาะจงเกี่ยวกับพฤติกรรมที่คาดหวัง ตัวอย่าง 1) MethodName_StateUnderTest_ExpectedBehavior Public void Sum_NegativeNumberAs1stParam_ExceptionThrown() Public void Sum_NegativeNumberAs2ndParam_ExceptionThrown () Public void Sum_simpleValues_Calculated () ที่มา: การตั้งชื่อมาตรฐานสำหรับการทดสอบหน่วย 2) การแยกแต่ละคำด้วยการขีดเส้นใต้ Public void Sum_Negative_Number_As_1st_Param_Exception_Thrown() Public void Sum_Negative_Number_As_2nd_Param_Exception_Thrown () Public void Sum_Simple_Values_Calculated () อื่น ๆ สิ้นสุดชื่อวิธีด้วยการทดสอบ เริ่มต้นชื่อเมธอดพร้อมชื่อคลาส

7
มีแนวทางปฏิบัติที่ดีที่สุดสำหรับองค์กรแพ็คเกจ (Java) หรือไม่ [ปิด]
ปิด คำถามนี้เป็นคำถามความคิดเห็นตาม ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบข้อเท็จจริงและการอ้างอิงได้โดยแก้ไขโพสต์นี้ ปิดให้บริการใน4 ปีที่แล้ว ปรับปรุงคำถามนี้ เมื่อไม่นานมานี้ฉันเห็นคำถามตอบที่นี่เกี่ยวกับองค์กร Java package ตัวอย่างเช่นmy.project.util, my.project.factory, my.project.serviceฯลฯ ฉันหามันไม่พบในตอนนี้ดังนั้นฉันอาจถามคำถามเช่นกัน มีแนวทางปฏิบัติที่ดีที่สุดเกี่ยวกับองค์กรของแพคเกจใน Java และสิ่งที่เกิดขึ้นในพวกเขา? คุณจะจัดการชั้นเรียนของคุณในโครงการ Java ของคุณได้อย่างไร ตัวอย่างเช่นโครงการที่ฉันกำลังทำงานกับบางคนมีแพ็คเกจที่เรียกว่า beans มันเริ่มต้นจากการเป็นโครงการที่มีถั่วเรียบง่าย แต่ได้จบลง (ผ่านประสบการณ์ที่ไม่ดีและไม่มีเวลา) ที่มีทุกอย่าง (เกือบ) ฉันได้ทำความสะอาดเล็กน้อยโดยใส่คลาสโรงงานลงในแพ็คเกจโรงงาน (คลาสที่มีวิธีการคงที่ที่สร้างถั่ว) แต่เรามีคลาสอื่น ๆ ที่ใช้ตรรกะทางธุรกิจและอื่น ๆ ที่ทำการประมวลผลอย่างง่าย (ไม่ใช่กับตรรกะทางธุรกิจ) เช่นการดึง ข้อความสำหรับโค้ดจากไฟล์คุณสมบัติ ความคิดและความคิดเห็นของคุณได้รับการชื่นชม

7
แก้ไขการใช้อักษรตัวพิมพ์ใหญ่ของตัวแปรสคริปต์ Bash และ shell
ฉันใช้เชลล์สคริปต์จำนวนมากที่มีตัวแปรในตัวพิมพ์ใหญ่ทั้งหมดและฉันคิดเสมอว่ามีความเข้าใจผิดที่รุนแรง ความเข้าใจของฉันคือว่าโดยการประชุม (และอาจจำเป็นนานแล้ว) ตัวแปรสภาพแวดล้อมอยู่ในตัวพิมพ์ใหญ่ทั้งหมด แต่ในสภาพแวดล้อมที่มีการเขียนสคริปต์ที่ทันสมัยเช่นทุบตีฉันได้ต้องการเสมอประชุมของชื่อกรณีที่ต่ำกว่าสำหรับตัวแปรชั่วคราวและคนบนกรณีเฉพาะสำหรับการส่งออกตัวแปร (เช่นสภาพแวดล้อม) ตัวอย่างเช่น: #!/usr/bin/env bash year=`date +%Y` echo "It is $year." export JAVA_HOME="$HOME/java" นั่นเป็นสิ่งที่ฉันทำ มีแหล่งข้อมูลที่เชื่อถือได้ซึ่งเห็นด้วยหรือไม่เห็นด้วยกับวิธีการนี้หรือเป็นเรื่องของสไตล์อย่างหมดจดหรือไม่?

2
ข้อตกลงการตั้งชื่อ PostgreSQL
ฉันจะหาคู่มือโดยละเอียดเกี่ยวกับแบบแผนการตั้งชื่อของ PostgreSQL ได้ที่ไหน (ชื่อตารางเทียบกับกรณีของอูฐลำดับคีย์หลักข้อ จำกัด ดัชนี ฯลฯ ... )

6
อนุสัญญาการตั้งชื่อสำหรับ MongoDB คืออะไร
มีชุดของอนุสัญญาการตั้งชื่อที่ต้องการสำหรับสิทธิ์ MongoDB เช่นฐานข้อมูล, คอลเลกชัน, ชื่อฟิลด์หรือไม่? ฉันกำลังคิดตามบรรทัดเหล่านี้: ฐานข้อมูล: ประกอบด้วยวัตถุประสงค์ (คำเป็นเอกพจน์) และลงท้ายด้วย“ db” - ตัวพิมพ์เล็กทั้งหมด: imagedb, resumedb, memberdb ฯลฯ คอลเลกชัน: พหูพจน์ในกรณีที่ต่ำกว่า: รูปภาพ, ประวัติย่อ, ฟิลด์เอกสาร: lowerCamelCase เช่น memberFirstName, fileName ฯลฯ

18
URL: ขีดกลางกับขีดเส้นใต้ [ปิด]
ปิด. คำถามนี้เป็นคำถามปิดหัวข้อ ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้เป็นไปตามหัวข้อสำหรับ Stack Overflow ปิดให้บริการใน7 ปีที่ผ่านมา ปรับปรุงคำถามนี้ มันควรจะเป็น/ about_usหรือ/ เกี่ยวกับเรา ? จากมุมมองการใช้งานส่วนตัวแล้วฉันคิดว่า/ เกี่ยวกับเราดีกว่ามากสำหรับผู้ใช้ปลายทาง แต่ Google และเว็บไซต์อื่น ๆ ส่วนใหญ่ (และกรอบงานจาวาสคริปต์) ใช้รูปแบบการขีดเส้นใต้ มันเป็นเรื่องของสไตล์หรือไม่? มีปัญหาความเข้ากันได้กับขีดกลางหรือไม่

13
ทำไมเครื่องหมายดอกจันอยู่ข้างหน้าชื่อตัวแปรแทนที่จะเป็นประเภทหลัง
ทำไมตัวแปรชื่อโปรแกรมเมอร์ซีส่วนใหญ่เช่นนี้: int *myVariable; มากกว่าเช่นนี้ int* myVariable; ทั้งสองถูกต้อง ดูเหมือนว่าฉันว่าเครื่องหมายดอกจันเป็นส่วนหนึ่งของประเภทไม่ใช่ส่วนหนึ่งของชื่อตัวแปร ใครสามารถอธิบายเหตุผลนี้

2
การตั้งชื่อของ enums ใน Java: เอกพจน์หรือพหูพจน์?
มีคำแนะนำ "อย่างเป็นทางการ" ของวิธีตั้งชื่อ enums Java หรือไม่ enum Protocol { HTTP, HTTPS, FTP } หรือ enum Protocols { HTTP, HTTPS, FTP } ฉันรู้ว่าในโลกของ. Net คำแนะนำคือการใช้เอกพจน์ยกเว้นสำหรับ enums ที่เป็นตัวแทนของธงบิต แค่สงสัยว่ามีอะไรที่คล้ายกันใน Java คำถามที่เกี่ยวข้องที่ดูเหมือนจะเป็น. เฉพาะสุทธิ: เอกพจน์หรือพหูพจน์สำหรับการแจกแจง?

6
เมื่อใดที่“ ลอง” ควรจะใช้ในชื่อเมธอด C #
เรากำลังพูดคุยกับเพื่อนร่วมงานของเราเกี่ยวกับความหมายว่าถ้าชื่อวิธีการขึ้นต้นด้วย "ลอง" มีความคิดเห็นดังต่อไปนี้: ใช้ "ลอง" เมื่อวิธีสามารถคืนค่าเป็นศูนย์ได้ ใช้ "ลอง" เมื่อวิธีการจะไม่เกิดข้อยกเว้น คำจำกัดความอย่างเป็นทางการคืออะไร "ลอง" พูดในชื่อวิธีการอะไร? มีแนวทางที่เป็นทางการเกี่ยวกับเรื่องนี้หรือไม่?


12
แบบแผนการตั้งชื่อ:“ รัฐ” กับ“ สถานะ” [ปิด]
ปิด คำถามนี้เป็นคำถามความคิดเห็นตาม ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบข้อเท็จจริงและการอ้างอิงได้โดยแก้ไขโพสต์นี้ ปิดให้บริการใน7 ปีที่ผ่านมา ปรับปรุงคำถามนี้ คำถามด่วน: ฉันต้องการฟังความคิดเห็นของคุณเมื่อใช้ "สถานะ" กับ "สถานะ" เมื่อตั้งชื่อทั้งสองฟิลด์เช่น "Foo.currentState" vs "Foo.status" และประเภทเช่น "enum FooState" vs "enum FooStatus" มีการประชุมหารือกันหรือไม่? เราควรใช้เพียงอย่างเดียวหรือไม่ ถ้าเป็นอย่างนั้นเราควรเลือกอย่างไร?

โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.