รูปแบบการต่อต้านการตั้งชื่ออะไรอยู่? [ปิด]

มีบางชื่อที่ถ้าคุณพบว่าตัวเองชื่อคุณรู้ว่าคุณได้ทำบางสิ่งบางอย่างสับสน

ตัวอย่างเช่น:

XxxManager
สิ่งนี้ไม่ดีเนื่องจากคลาสควรอธิบายว่าคลาสทำอะไร หากคำที่เฉพาะเจาะจงที่สุดที่คุณสามารถคิดได้ในสิ่งที่ชั้นเรียนทำคือ "จัดการ" ชั้นเรียนนั้นใหญ่เกินไป

มีรูปแบบการต่อต้านการตั้งชื่ออื่น ๆ อีกบ้าง?

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

รูปแบบการต่อต้านการตั้งชื่อต่อไปนี้เกี่ยวข้องกับ. NET และโดยเฉพาะ C #:

• ไม่สอดคล้องกัน ถ้าคุณตัดสินใจที่จะเริ่มต้นชื่อทุกสาขาที่มีขีดชั้นนำติดมัน
• ตัวย่อ Ambiguos กับสระหายไป cxtCtrlMngrฉันได้เห็นอย่างจริงจังชื่อฟิลด์เช่น คุณแทบจะไม่สามารถเดาได้ว่าสิ่งที่ควรจะเป็น
• ยาวเกินไปและ verbose ชื่อตัวแปร ILoginAttemptRepositoryดีและเป็นคำอธิบาย - ILoginAttemptRepositoryUsingEntityFrameworkForObjectRelationalMappingเป็นคำอธิบาย แต่ไม่แน่นอน

หนึ่งที่ฉันพบบ่อยคือเพียงไม่ใช้รูปแบบการตั้งชื่อเลย โดยทั่วไปแล้วบ่งบอกถึงความไม่รู้ของนักพัฒนา (รูปแบบการตั้งชื่อนั้นเป็นสิ่งที่ดี ) และรูปแบบการต่อต้านนี้มีแนวโน้มที่จะละเมิด SRP อย่างไม่ลดหย่อนโดยการบรรจุวิธีการทุกชนิดที่เป็น kinda / sorta ที่เกี่ยวข้องกับคลาสในคลาสนั้น class มีคุณสมบัติ, วิธีการ CRUD, สิ่งที่เกี่ยวข้องกับลูกค้าจากระยะไกลซึ่งบางส่วนของแอปพลิเคชันต้องการ

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

คำตอบง่ายๆก่อนอื่นให้พิมพ์ภาษาฮังการี ( http://mindprod.com/jgloss/unmainnaming.htmlยังมีความคิดอื่น ๆ อีกมาก) มุมมองที่สมดุลมากขึ้นเมื่อชาวฮังการีไม่ใช่คนชั่วร้าย http://www.joelonsoftware.com /articles/Wrong.html )

คำนำหน้า 'I' เป็นชื่อของอินเทอร์เฟซหรือ 'Abstract' เป็นชื่อของคลาสนามธรรม สิ่งนี้อาจนำมาใช้ซ้ำได้ในภาษาที่ไม่มีแนวคิดของคลาสนามธรรมหรือที่ไม่แยกความแตกต่างระหว่างอินเทอร์เฟซและคลาสนามธรรม - แต่ใน Java ตัวอย่างเช่นมันเป็นความคิดที่ไม่ดีเสมอ

นอกจากนี้ฉันไม่เห็นด้วยกับคุณในสิ่งที่ผู้จัดการ ฉันใช้รูปแบบนั้นในบางครั้งและมันก็หมายความว่าถ้าฉันพยายามตั้งชื่ออย่างอื่นชื่อนั้นจะไม่อธิบายใด ๆ มากกว่า XxxxxManager มีงานบางอย่าง (ไม่จำเป็นต้องสลับซับซ้อน) ที่ไม่สามารถสรุปได้อย่างเรียบร้อยในหนึ่งหรือสองคำ

Speeling:

ฉันมีความพิการและไม่สามารถสะกดได้ ไม่มีตัวตรวจสอบการสะกดฉันไม่มีอำนาจฉันพยายามคัดลอกชื่อทั้งหมดที่ฉันสร้างไปยังโปรแกรมประมวลผลคำเพื่อการตรวจสอบ แต่ฉันมักจะพลาดบางส่วน ในโครงการสุดท้ายของฉันฉันเขียนส่วนใหญ่ของ api และฉันเดาว่าฉันไม่ได้ตรวจสอบการสะกดในครั้งแรกที่ฉันใช้คำตอบของคำตอบและฉันคิดว่ามันถูกต้องเพราะไม่มีใครบอกฉัน เรามีฟังก์ชั่นอย่างน้อย 50 ฟังก์ชั่นพร้อมการตอบกลับ มีคนใหม่เข้ามาในทีมและถามว่าทำไมเราถึงใช้ responce ฉันรู้สึกว่าโง่จริง ๆ

ฉันเกรงว่าความคิดเห็นของฉันจะขัดแย้งกันเล็กน้อย แต่ลอง ...

เท่าที่ฉันกังวลฉันต้องเห็นด้วยกับ Mike Baranczak ชื่ออย่าง XxxController, XxxHandler เป็นสิ่งที่เราใช้บ่อยมาก สำหรับเราผู้ควบคุมนั้นเป็นเหมือนจุดเริ่มต้นสำหรับบางสิ่งที่ "ห่อหุ้ม" เช่นการจัดการธุรกรรมการจัดการกับข้อผิดพลาดที่ไม่คาดคิดการเรียก XxxHandler สำหรับการทำงานจริง ฉันจะบอกว่า XxxManager เป็นคำพ้องความหมายสำหรับตัวควบคุม ฉันคิดว่ามันสำคัญที่จะไม่ใช้ Manager ในกรณีหนึ่งและคอนโทรลเลอร์ในอีกกรณีหนึ่ง ความสอดคล้องเป็นสิ่งสำคัญหากคุณทำงานเป็นทีม

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

สิ่งที่ฉันไม่ชอบคือเมื่อเมธอดที่เรียกว่า get ... หรือ set ... เป็นมากกว่า accessor ธรรมดา ๆ ฉันชอบเดช ... เพื่อพิจารณา

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

ฉันเองก็เป็นแฟนตัวยงของสัญกรณ์ระบบฮังการี - ส่วนใหญ่คุณกำลังติดต่อกับซอร์สโค้ดใน IDE ตกลง แต่บ่อยครั้งที่คุณใช้โปรแกรมแก้ไขหรือคุณเรียกดู repo ในเบราว์เซอร์ ข้อเสียอย่างหนึ่งอาจเป็นเครื่องมือสนับสนุนเนื่องจากคำนำหน้าประเภท ...

ฉันคิดว่าสิ่งที่สำคัญที่สุดคือ beeing consitent - อนุสัญญาไม่ดี - สำหรับฉัน - ดีกว่าที่ไม่มีการประชุม ...

บางทีรูปแบบการตั้งชื่อที่แย่ที่สุดก็คือ

create table stuff(..., foo1 string, bar1 string,
                        foo2 string, bar2 string, 
                        foo3 string, bar3 string, ...)

เรามีรายการสามองค์ประกอบของคู่ [foo, bar] ถ้าเราต้องการหนึ่งในสี่เราจะต้องเพิ่มคอลัมน์ใหม่ลงในตาราง

นำไปสู่รหัสเช่นนี้:

'SELECT foo' + i + ', bar' + i + ' FROM stuff'

ควรสร้างตารางแยกต่างหากด้วยคอลัมน์ foo และ bar และเชื่อมโยงกับตารางรายการ:

create table fubar(foo string, bar string, stuff_id long)

สิ่งที่เลวร้ายที่สุดอันดับสองคือ:

class Student {
  ...
  String homeStreet;
  String homeCity;
  String homeState;
  String permStreet;
  String permCity;    
  String permState;
  ...
}

ที่นี่เรามีหกฟิลด์แทนสองอินสแตนซ์ของคลาสที่อยู่

รูปแบบการต่อต้านนี้ถูกทำเครื่องหมายด้วยชุดชื่อสองส่วนที่แสดงรายการทุกชุดของสองชุดเช่น [foo, bar] x [1,2,3] หรือ [home, Perm] x [ถนน, เมือง, state]

การตั้งชื่อคลาสหรืออินเทอร์เฟซใด ๆ ที่เป็นเรื่องที่ซ้ำซากนั้นเป็นสิ่งที่ไม่ดีไม่ใช่แค่ใน Java ที่ลิงก์พูดถึง แต่เป็นภาษาใด ๆ

Tautology (วาทศาสตร์) ใช้คำที่แตกต่างกันในการพูดในสิ่งเดียวกันแม้ว่าการทำซ้ำไม่ได้ให้ความชัดเจน

ฉันมักพบห้องสมุดซอฟแวร์ที่มีชื่อทั่วไปเช่นหรือLibrary Commonพวกเขาบ่งบอกถึงการออกแบบที่ไม่ดี: นักพัฒนาพยายามที่จะหลีกเลี่ยงการทำสำเนารหัส แต่ไม่มีความพยายามใด ๆ ที่จะสร้างการออกแบบที่สลายตัวบนพื้นฐานของการทำงาน

จากMicrosoftในการตั้งชื่อฉันสามารถให้รายการนี้สำหรับชื่อที่ไม่ดี:

1. พวกเขาจะไม่ความหมายซึ่งหมายความว่าพวกเขามีชื่อซึ่งแทนที่จะเน้นสิ่งที่มันไม่ให้ความสำคัญกับเทคโนโลยีที่ใช้หรือรูปแบบก็ขึ้นอยู่กับ
2. พวกเขาไม่ปฏิบัติตามความสอดคล้องด้านไวยากรณ์ ตัวอย่างเช่นส่วนหนึ่งของชื่อจะถูกใส่อูฐในขณะที่ส่วนอื่น ๆ จะเป็นปาสคาล
3. มันเป็นตัวย่อซึ่งยากที่จะเข้าใจเช่นScrollableXแทนที่จะเป็นCanScrollH แนวนอน
4. พวกเขาเลือกเช่นที่พวกเขายุ่งกับคำหลักของสภาพแวดล้อมที่