การใช้ชื่อพารามิเตอร์ที่แตกต่างจากชื่อประเภทเท่านั้นโดยปลอกถือเป็นแนวทางปฏิบัติที่ไม่ดีใน C #?

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

public Range PadRange(Range range) {}

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

ระยะทางทางจิตวิทยาสามารถกำหนดได้ว่าเป็นความง่ายในการแยกความแตกต่างของสองรายการ ... เมื่อคุณดีบั๊กให้พร้อมสำหรับปัญหาที่เกิดจากระยะห่างทางจิตใจไม่เพียงพอระหว่างชื่อตัวแปรที่คล้ายกันและระหว่างชื่อรูทีนที่คล้ายกัน ในขณะที่คุณสร้างรหัสให้เลือกชื่อที่มีความแตกต่างมากเพื่อให้คุณสามารถหลีกเลี่ยงปัญหาได้

ลายเซ็นวิธีการของฉันมี "ช่วง" มากมายเกิดขึ้นดังนั้นจึงรู้สึกว่ามันอาจเป็นปัญหาเกี่ยวกับระยะห่างทางจิตวิทยานี้ ตอนนี้ฉันเห็นนักพัฒนาหลายคนทำต่อไปนี้

public Range PadRange(Range myRange) {}

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

ฉันยังเห็นดังต่อไปนี้

public Range PadRange(Range rangeToPad) {}

ฉันชอบสิ่งนี้ดีกว่าส่วนนำหน้า "ของฉัน" แต่ก็ยังไม่สนใจโดยรวม มันรู้สึก verbose มากเกินไปสำหรับฉันและอ่านอย่างเชื่องช้าเป็นชื่อตัวแปร สำหรับฉันมันเป็นที่เข้าใจกันดีว่าช่วงนั้นจะถูกเพิ่มเนื่องจากชื่อเมธอด

ดังนั้นเมื่อทั้งหมดนี้ออกมาอุทรของฉันคือการได้ไปกับลายเซ็นแรก สำหรับฉันมันสะอาด ไม่จำเป็นต้องบังคับบริบทเมื่อไม่จำเป็น แต่ฉันทำตัวเองหรือผู้พัฒนาในอนาคตเป็นความเสียหายกับการประชุมนี้หรือไม่? ฉันกำลังละเมิดแนวปฏิบัติที่ดีที่สุดหรือไม่?

อย่าคิดมากเรื่องนี้Range rangeดี ฉันใช้การตั้งชื่อแบบนี้มานานกว่า 15 ปีใน C # และอาจนานกว่าใน C ++ และไม่เคยพบข้อเสียจริงจากมันเลย

แน่นอนว่าเมื่อคุณมีตัวแปรท้องถิ่นที่แตกต่างกันในขอบเขตเดียวกันทุกประเภทเดียวกันมันอาจจะช่วยให้คุณใช้ความพยายามในการแยกแยะความแตกต่างได้อย่างถูกต้อง

ฉันทำสิ่งนี้ตลอดเวลามันทำให้ฉันสบายใจ ถ้ามันเป็นข้อโต้แย้งที่ส่งผ่านไปยังตัวสร้างที่จะต้องได้รับมอบหมายให้สมาชิกสมาชิกของฉันจะได้รับการตั้งชื่อช่วงเช่นกันและการมอบหมายจะเป็น

this.range = range;

และโดยปกติฉันจะมีคุณสมบัติชื่อ Range

พวกมันต่างกันเหมือนกันต่างกันในบริบทที่ต่างกันดังนั้นจึงควรใช้ชื่อเดียวและคุณจะต้องจำชื่อเพียงชื่อเดียวเท่านั้น มันเป็นสิ่งหนึ่งความแตกต่างทางเทคนิคล้วนๆ

คุณควรเข้มงวดกับสมาชิกที่มีคุณสมบัติครบถ้วนด้วย "สิ่งนี้" แม้ว่านั่นเป็นสิ่งที่ StyleCop มีไว้สำหรับ

บันทึกข้าง StyleCop

รับประกันการโต้เถียง!

สำหรับผู้ที่ต่อต้านการใช้ "สิ่งนี้": ฉันได้เห็นแล้วว่า _, m, m_ และไม่มีอะไรเลย ภาษาเองกำลังเสนอวิธีที่ชัดเจนและชัดเจนในระดับสากลที่บ่งบอกว่าเรากำลังติดต่อกับสมาชิกชั้นเรียน ทำไมบนโลกนี้คุณต้องการที่จะสร้างวิธีการของคุณเองที่ทำให้ชื่อที่สมบูรณ์แบบถูกทำลายไปแล้ว?

เหตุผลเดียวที่ฉันสามารถคิดได้ว่ามันเป็นนิสัยที่สืบทอดมาจากยุค C เมื่อจริง ๆ แล้วมันสมเหตุสมผลที่จะทำเพราะไม่มีวิธีอื่น

"มันเป็นตัวละครมากขึ้น!" อย่างจริงจัง? "เวลารวบรวมจะพุ่งสูงขึ้น!" อย่างจริงจัง? ฉันจะต้องยกก้อยเมื่อพิมพ์! " ราวกับว่าเวลาในการพิมพ์มีความสำคัญในเวลาการพัฒนาทั้งหมด

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

StyleCop ทำอะไรได้มากกว่านี้ (ฮ่าฮ่า) มีหลายวิธีที่นักพัฒนาสามารถ (เพียงพิจารณาการจัดรูปแบบโค้ด) ทำให้รอดพ้นจากงานบำรุงรักษาของผู้สืบทอดของเขา StyleCop ป้องกันส่วนใหญ่ มันมีค่ามาก

หากคุณยังใหม่กับมัน: โดยทั่วไปแล้วจะทำให้คุณบ่นประมาณหนึ่งหรือสองสัปดาห์แล้วคุณจะรักมัน

คำแนะนำตัวเองของฉันเกี่ยวกับวิธีการตั้งชื่อพารามิเตอร์และตัวแปรนั้นค่อนข้างง่าย:

1. หากชื่อมีประเภทที่ถูกส่งหรือส่งคืนแสดงว่าคุณทำผิด
2. ตั้งชื่อสิ่งต่าง ๆ ตามสิ่งที่พวกเขาตั้งใจไว้ไม่ใช่สิ่งที่พวกเขาทำ
3. โปรดจำไว้ว่ารหัสนั้นอ่านมากกว่าที่เขียนไว้

ดังนั้นวิธีการที่ดีที่สุดในความคิดของฉันจะเป็น:

Range Pad(Range toPad)

การย่อชื่อเมธอดคือการอธิบายตนเอง

ชื่อพารามิเตอร์toPadจะบอกผู้อ่านทันทีว่าพารามิเตอร์นั้นน่าจะถูกแก้ไขแบบแทนที่ด้วยการบุรองแล้วส่งคืน rangeในทางตรงกันข้ามไม่มีสมมติฐานสามารถทำเกี่ยวกับชื่อตัวแปร

นอกจากนี้ในเนื้อความจริงของวิธีการRangeตัวแปรอื่น ๆที่ถูกนำเสนอจะ (ควร) ตั้งชื่อตามความตั้งใจของพวกเขาดังนั้นคุณอาจจะมีpaddedและunpadded... toPadสอดคล้องกับอนุสัญญาการตั้งชื่อเหล่านั้น แต่rangeเพียงแค่ยื่นออกมาและไม่ได้เจล

สำหรับการตั้งชื่อองค์ประกอบรหัส (ประเภทตัวแปรฟังก์ชั่นอะไรก็ได้) คำถามสำคัญที่ถามตัวเองคือ

ถ้าฉันพิมพ์ผิดคอมไพเลอร์จะพบมันให้ฉันได้ไหม

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

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

ที่คุณจะต้องกังวลจะเป็นอย่างไรถ้ามีสองตัวแปรวิธีการฟังก์ชั่นหรือคุณสมบัติในขอบเขตปัจจุบันเรียกว่าและrange Rangeในกรณีนั้นคอมไพเลอร์อาจจะปล่อยให้ผ่านและคุณจะได้รับพฤติกรรมที่ไม่คาดคิดในเวลาทำงาน โปรดทราบว่านั่นคือองค์ประกอบรหัสสองประเภทใด ๆไม่ใช่แค่ "ตัวแปรสองตัว" หรือ "สองฟังก์ชั่น" - ทั้งหมดนี้สามารถส่งเข้าหากันโดยปริยายโดยมีการสังหารเกิดขึ้นเมื่อทำงาน คุณอาจได้รับคำเตือน แต่คุณไม่สามารถรับประกันอะไรได้มากกว่านั้น คุณมีปัญหาที่คล้ายกันถ้าคุณได้สองประเภทประกาศเรียกและrangeRange

นอกจากนี้โปรดทราบว่าลักษณะเดียวกันนี้ใช้กับรูปแบบสัญกรณ์ฮังการีซึ่งชื่อจะถูกนำหน้าด้วยอักขระอย่างน้อยหนึ่งตัวเพื่อพูดอะไรเพิ่มเติมเกี่ยวกับสิ่งที่เป็น หากคุณมีตัวแปรที่เรียกว่าRangeและตัวชี้ไปยังเรียกว่าPRangeมันง่ายที่จะพลาดโดยบังเอิญPเช่น C # ควรตรวจจับสิ่งนี้ แต่ C และ C ++ จะเตือนคุณอย่างมากเท่านั้น หรือมากกว่าไม่แยแสสมมติว่าคุณมีรุ่นที่เรียกว่าคู่DRangeและคุณ downsample FRangeที่ลอยรุ่นที่เรียกว่า ใช้ลอยหนึ่งโดยอุบัติเหตุ (ซึ่งเป็นเรื่องง่ายตั้งแต่คีย์จะอยู่ติดกันบนแป้นพิมพ์) และรหัสของคุณจะชนิดของการทำงาน แต่มันจะตกไปในรูปแบบที่แปลกและคาดเดาไม่ได้เมื่อกระบวนการไหลออกมาจากความละเอียดและ underflows

เราไม่ได้อยู่ในยุคที่เราตั้งชื่อได้ไม่เกิน 8 ตัวอักษรหรือ 16 ตัวอักษรหรือจำนวน จำกัด บางครั้งฉันก็ได้ยินว่าสามเณรบ่นเกี่ยวกับชื่อตัวแปรที่ยาวขึ้นทำให้การเข้ารหัสใช้เวลานานขึ้น มันเป็นสามเณรเท่านั้นที่บ่นเกี่ยวกับเรื่องนี้แม้ว่า นักเขียนที่จริงจังรู้ว่าสิ่งที่ต้องใช้เวลาจริงๆคือการหาข้อบกพร่องที่คลุมเครือ - และตัวเลือกที่ไม่ดีในการตั้งชื่อเป็นวิธีคลาสสิกที่จะปล่อยตัวเองในหลุมนั้น

เกร็ดเล็กเกร็ดน้อยหนึ่งที่ฉันต้องการเพิ่มในขณะที่Range rangeสิ่งนี้ถูกต้องตามกฎหมาย syntactically มันอาจทำให้สิ่งที่ท้าทายมากขึ้นในการแก้ปัญหาหรือ refactor กำลังมองหาตัวแปรหนึ่งตัวที่ชื่อว่า "ช่วง" ในไฟล์ที่มีตัวแปรประเภท Range มากมายอยู่ใช่ไหม คุณอาจจะทำงานมากขึ้นในภายหลังเนื่องจากตัวเลือกการตั้งชื่อนี้

นี่ขึ้นอยู่กับบริบทเป็นส่วนใหญ่ หากเป็นไฟล์ 30 บรรทัดคำสั่งของฉันจะไม่เข้าสู่การเล่นจริงๆ

ฉันคิดว่าคุณสามารถใช้Range rangeทุกวันนี้ได้ด้วยเหตุผลเดียวนั่นคือการเน้นไวยากรณ์ IDEs สมัยใหม่มักจะเน้นชื่อประเภทและชื่อพารามิเตอร์ในสีที่แตกต่างกัน นอกจากนี้ชนิดและตัวแปรยังมี "ระยะทางแบบลอจิคัล" พอสมควรเพื่อไม่ให้สับสนได้ง่าย

หากไม่เป็นเช่นนั้นฉันจะพิจารณาชื่ออื่นหรือพยายามเปิดใช้งานปลั๊กอิน / ส่วนขยายที่สามารถทำการเน้นไวยากรณ์นี้ได้

เมื่อฟังก์ชั่นเป็นแบบทั่วไปมันก็เป็นเหตุผลว่าพารามิเตอร์จะเป็นแบบทั่วไปและดังนั้นจึงควรมีชื่อสามัญ

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

public String removeNonDigits(String phoneNumber)

ชื่อฟังก์ชั่นฟังดูธรรมดามากแบบนี้สามารถใช้ได้กับหลาย ๆ สายในหลาย ๆ สถานการณ์ แต่ชื่อพารามิเตอร์นั้นจำเพาะเจาะจงอย่างมากทำให้ฉันสงสัยว่าชื่อฟังก์ชันนั้นทำให้เข้าใจผิดหรืออะไร

ดังนั้นแทนที่จะพูดว่า Range Range คุณสามารถพูด Range rangeToPad ได้ แต่สิ่งนี้เพิ่มข้อมูลอะไร? แน่นอนมันเป็นช่วงที่จะเสริม มันจะเป็นอะไรอีก?

การเพิ่มคำนำหน้าบางคำ "my" หรือ "m_" หรืออะไรก็ตามจะสื่อข้อมูลเพิ่มเติมให้กับผู้อ่าน เมื่อฉันใช้ภาษาที่คอมไพเลอร์ไม่อนุญาตให้ชื่อตัวแปรเหมือนกับชื่อประเภท - มีหรือไม่มีการพิจารณาตัวพิมพ์เล็ก - บางครั้งฉันใส่คำนำหน้าหรือคำต่อท้ายเพียงเพื่อรวบรวม . แต่นั่นเป็นเพียงการตอบสนองคอมไพเลอร์ ใคร ๆ ก็เถียงว่าแม้ว่าคอมไพเลอร์สามารถแยกแยะความแตกต่างนี้ทำให้มันง่ายขึ้นสำหรับผู้อ่านของมนุษย์ที่จะแยกแยะ แต่ว้าวใน Java ฉันได้เขียนคำสั่งเช่น "ลูกค้าลูกค้า = ลูกค้าใหม่ ();" พันล้านครั้งและฉันไม่เคยพบว่ามันสับสน (ฉันมักจะพบว่ามันซ้ำซ้อนเล็กน้อยและฉันชอบแบบนั้นใน VB คุณสามารถพูดว่า "ลูกค้าสลัวในฐานะลูกค้าใหม่" และคุณไม่ต้องให้ชื่อคลาสสองครั้ง)

ตำแหน่งที่ฉันคัดค้านอย่างยิ่งต่อชื่อทั่วไปคือเมื่อมีอินสแตนซ์ประเภทเดียวกันสองรายการขึ้นไปในฟังก์ชันเดียวกัน พารามิเตอร์โดยเฉพาะอย่างยิ่ง ชอบ:

public Range pad(Range range1, Range range2)

ความแตกต่างระหว่าง range1 และ range2 คืออะไร ฉันควรจะรู้ได้อย่างไร? ถ้ามันเป็นสิ่งที่พวกเขาเป็นค่าทั่วไปและค่าที่เปลี่ยนแปลงได้สองค่าจริง ๆ เช่น

public boolean overlap(Range range1, Range range2)

ฉันคาดหวังว่าจะให้ผลลัพธ์เป็นจริงหากช่วงทับซ้อนและเป็นเท็จถ้าไม่มีดังนั้นจึงเป็นแบบทั่วไปและใช้แทนกันได้

แต่ถ้าพวกมันต่างกันให้ฉันรู้ว่ามันต่างกันอย่างไร! ฉันเพิ่งทำงานกับโปรแกรมเมื่อเร็ว ๆ นี้ที่มีคลาส "สถานที่" เพื่อเก็บข้อมูลเกี่ยวกับสถานที่ทางภูมิศาสตร์และด้วยตัวแปรประเภทนี้ที่ชื่อ "p", "สถานที่", "สถานที่", "สถานที่ 2", "myPlace" ฯลฯ ว้าว ชื่อจริง ๆ ช่วยฉันพิจารณาว่าอันไหน