หลักการตั้งชื่อที่ดีสำหรับประเภททั่วไปใน C # คืออะไร [ปิด]

ฉันตัดสินใจถามคำถามนี้ที่นี่แทนที่จะเป็นแบบล้นสแต็กเพราะมันค่อนข้างเป็นอัตนัย

ใน C # ปกติฉันเห็นประเภททั่วไปที่มีชื่อไม่ดี โดยทั่วไปมักใช้ "T" แต่ไม่ใช่ชื่อที่สื่อความหมายด้วยตัวเอง ตัวอย่างเช่น:

class Fruit<T>
{
    T fruit;
}

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

ในตัวอย่างก่อนหน้านี้สมมติว่าประเภททั่วไปTมักจะต้องเป็นชนิดของผลไม้เช่นหรือApple OrangeประเภทTต้องทำให้ชัดเจนว่าเป็นผลไม้ชนิดหนึ่งดังนั้นอาจเป็นชื่อที่ดีกว่าFruitTypeดังนั้นเราจึงจบลงด้วย:

class Fruit<FruitType>
{
    FruitType fruit;
}

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

มันย่อมเป็นอัตนัย ... ish
เนื่องจากบางคนพบว่าiมีความถูกต้องสมบูรณ์แบบสำหรับตัวแปรลูปบางคนคิดว่าTใช้ได้อย่างสมบูรณ์แบบสำหรับตัวยึดตำแหน่งประเภทในคลาสทั่วไป

โดยส่วนตัวแล้วฉันใช้วิธีนี้เป็นแบบแผนทั่วไปและคนทั่วไปรู้ว่าคุณหมายถึงอะไร

ประเภทที่มีความหมายฉันจะใช้ชื่อที่มีความหมาย แต่โดยทั่วไปแล้วจะเริ่มต้นด้วย T เมื่อเร็ว ๆ นี้ฉันได้พัฒนาคลาสพจนานุกรมทั่วไป (ไม่ต้องถาม) และการประกาศคือ

public class Dictionary<TKey, TValue>

อย่างไรก็ตามสำหรับบางอย่างเช่น Tuple ที่ประเภทไม่มีความหมายเป็นหลักฉันคิดว่าต่อไปนี้เป็นที่ยอมรับอย่างสมบูรณ์

public class Tuple<T1, T2, T3>

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

คุณสามารถเลือก T เป็นคำนำหน้าเหมือนกับหลาย ๆ คนที่เลือกฉันสำหรับอินเทอร์เฟซ ดังนั้น

class Juice<TFruit> where TFruit...

จะเป็นชื่อที่ดีในความเห็นของฉัน ฉันชอบคำนำหน้าเป็นคำต่อท้ายในกรณีส่วนใหญ่เนื่องจากชัดเจนว่าคุณเห็นอะไรในเวลาที่คุณสะดุดเมื่อมันสะดุดและง่ายต่อการค้นหาด้วยสิ่งต่าง ๆ เช่น Intellisense เป็นแนวปฏิบัติที่ดีสำหรับ UI-Controls เช่นกันเมื่อคุณมักจะรู้ประเภท (เช่นกล่องข้อความ) แต่ไม่แน่ใจ 100% เกี่ยวกับชื่อที่คุณให้คำอธิบาย

ด้านลบของมันคือมันดูไม่ดีเมื่อตัวพิมพ์เริ่มต้นด้วย T ดังนั้นฉันคิดว่ามันจะเป็นสิ่งที่ดีที่จะต่อท้ายประเภททั่วไปในกรณีพิเศษเช่นด้านล่าง

class SomeAlgorithm<TypeT> where TypeT : Type

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

Microsoft มีแนวทางอย่างเป็นทางการเกี่ยวกับข้อมูลทั่วไป: ชื่อของคลาส, โครงสร้างและอินเทอร์เฟซ (อ้างถึงที่นี่และในรูปแบบหนังสือ: แนวทางการออกแบบกรอบ )

เกี่ยวกับคำถามเฉพาะของคุณมันบอกว่า:

อย่าตั้งชื่อพารามิเตอร์ประเภททั่วไปที่มีชื่อที่สื่อความหมายเว้นแต่ชื่อตัวอักษรเดียวจะอธิบายตนเองได้อย่างสมบูรณ์และชื่อที่สื่อความหมายจะไม่เพิ่มมูลค่า

IDictionary<TKey, TValue> 

เป็นตัวอย่างของอินเทอร์เฟซที่เป็นไปตามหลักเกณฑ์นี้

พิจารณาใช้ตัวอักษร T เป็นชื่อพารามิเตอร์ประเภทสำหรับประเภทที่มีพารามิเตอร์ประเภทตัวอักษรเดียว

ทำชื่อพารามิเตอร์ประเภทคำอธิบายนำหน้าด้วยตัวอักษร T

พิจารณาระบุข้อ จำกัด ที่วางไว้บนพารามิเตอร์ type ในชื่อของพารามิเตอร์ ตัวอย่างเช่นพารามิเตอร์ที่ จำกัด กับ ISession อาจเรียกว่า TSession

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

อย่างไรก็ตามบางครั้งคลาสหรือวิธีการทั่วไปมีพารามิเตอร์ประเภทมากกว่าหนึ่งและ ณ จุดนี้มันทำให้รู้สึกเพื่อให้พวกเขามีชื่ออธิบายเพิ่มเติมเพื่อให้บทบาทของพวกเขากลายเป็นที่ชัดเจน ตัวอย่างที่ดีสำหรับประเภทการรวบรวมคีย์ - ค่าซึ่งทั้งคีย์และค่าเป็นแบบทั่วไป เรียกพวกเขาTและS(หรือQหรืออะไรก็ตาม) จะมีประโยชน์น้อยกว่าเรียกพวกเขาพูดKeyTypeและValueTypeหรือและTKeyTVal

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

ต่อไปนี้เป็นอนุสัญญาที่ฉันเรียนรู้และปฏิบัติตาม:

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

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

• พารามิเตอร์ประเภททั่วไปหลายรายการในคลาสเดียวกันหรือการประกาศเมธอดควรเริ่มต้นด้วย T แต่จะแตกต่างกันด้วยวิธีการที่กระชับ แต่เข้าใจได้ง่าย TInและTOutตัวอย่างเช่นเป็น GTP ทั่วไปและเข้าใจกันดีสำหรับวิธีการที่ยอมรับอินพุตทั่วไปที่พิมพ์อย่างรุนแรงและสร้างเอาต์พุตทั่วไปที่พิมพ์ออกมาอย่างรุนแรง

• หลายประเภทที่แตกต่าง แต่ไม่เหมือนกันเช่นสำหรับคลาสที่บรรจุเช่น. Tuple หรือประเภทผู้แทนเช่น Func, Predicate และ Action สามารถติดป้ายกำกับ T1, T2, T3 และอื่น ๆ อย่างไรก็ตามการประกาศ GTP ที่น่าทึ่ง (มีวัตถุประสงค์ที่ชัดเจนและ / หรือข้อ จำกัด ประเภทที่เฉพาะเจาะจงมาก) ควรมีคำอธิบายเพิ่มเติม

• ประเภททั่วไปเดียวในวิธีการซึ่งแตกต่างจากประเภททั่วไปของชั้นเรียนที่มีสามารถอย่างใดอย่างหนึ่งสามารถปฏิบัติตามกฎก่อนหน้านี้เกี่ยวกับหลายประเภทในชั้นเรียนหรือวิธีการหรือถ้าเป็นประเภทที่ไม่ธรรมดาอื่น ๆ กว่าจะแตกต่างกัน ตัวอักษรเดียวบ่อยหรือU Vนี่คือการประชุมอีกครั้งย้อนหลังไปถึงเทมเพลต C ++

• ไม่ว่าคุณจะเลือกทำอะไร อย่าติดป้าย GTP สำหรับชั้นหนึ่งและชั้นTถัดไปTParamเว้นแต่ชั้นที่สองจะซ้อนอยู่ในชั้นแรกทำให้Tไม่สามารถใช้งานได้ในชั้นที่สอง