การใช้งานสายอักขระ / หมายเลข [ปิด]

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

ในที่ทำงานของฉันเรามีแนวทางการเข้ารหัสที่เข้มงวด ส่วนหนึ่งของนั้นจะทุ่มเทให้กับสายอักขระ / หมายเลข มันระบุ (สำหรับ C #):

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

public class Whatever  
{  
   public static readonly Color PapayaWhip = new Color(0xFFEFD5);  
   public const int MaxNumberOfWheels = 18;  
}

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

mean = (a + b) / 2; // okay  
WaitMilliseconds(waitTimeInSeconds * 1000); // clear enough

สถานการณ์ในอุดมคติจะเป็นรายงานการวิจัยอย่างเป็นทางการที่แสดงผลกระทบต่อความสามารถในการอ่าน / การบำรุงรักษาโค้ดเมื่อ

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

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

private const char SemiColon = ';';
private const char Space = ' ';
private const int NumberTen = 10;

อีกตัวอย่างหนึ่งคือ (และนี่คือ JavaScript):

var someNumericDisplay = new NumericDisplay("#Div_ID_Here");

คุณติด DOM ID ที่ด้านบนของไฟล์จาวาสคริปต์ของคุณหรือไม่หากใช้รหัสนั้นในที่เดียวเท่านั้น

ฉันได้อ่านหัวข้อต่อไปนี้:
StackExchange
StackOverflow
Bytes ชุมชน IT
มีบทความอีกมากมายและหลังจากอ่านรูปแบบบางอย่างเหล่านี้ก็โผล่ออกมา

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

... เมื่อโต้เถียงกับเพื่อนร่วมงานคนหนึ่งของฉันใครจะเป็นผู้ประกาศค่าคงที่เช่น:

private const char SemiColon = ';';
private const char Space = ' ';
private const int NumberTen = 10;

การโต้เถียงที่คุณต้องทำกับเพื่อนร่วมงานของคุณไม่ได้เกี่ยวกับการตั้งชื่อพื้นที่ตามตัวอักษรSpaceแต่เป็นตัวเลือกที่ไม่ดีสำหรับค่าคงที่ของเขา

สมมติว่างานของรหัสของคุณคือการแยกวิเคราะห์กระแสข้อมูลที่มีเขตข้อมูลคั่นด้วยเครื่องหมายอัฒภาค ( a;b;c) และแยกด้วยช่องว่าง ( a;b;c d;e;f) หากใครก็ตามที่เขียนสเป็คของคุณโทรหาคุณในอีกหนึ่งเดือนข้างหน้าและพูดว่า "เราเข้าใจผิดฟิลด์ในบันทึกจะถูกคั่นด้วยสัญลักษณ์ไพพ์ ( a|b|c d|e|f)" คุณจะทำอย่างไร

ภายใต้รูปแบบที่คุ้มค่าตามชื่อเพื่อนร่วมงานที่คุณต้องการคุณต้องเปลี่ยนค่าของตัวอักษร ( SemiColon = '|') และใช้รหัสสดที่ยังคงใช้SemiColonกับบางสิ่งที่ไม่ใช่เซมิโคลอนอีกต่อไป ที่จะนำไปสู่การแสดงความคิดเห็นในเชิงลบในการตรวจสอบรหัส การขอทุเลาการที่คุณสามารถเปลี่ยนชื่อของตัวอักษรไปPipeSymbolและผ่านไปและการเปลี่ยนแปลงที่เกิดขึ้นของทุกการSemiColon PipeSymbolในอัตราดังกล่าวคุณอาจใช้เซมิโคลอน ( ';') ตามตัวอักษรในตอนแรกเนื่องจากคุณจะต้องประเมินการใช้งานแต่ละครั้งและคุณจะทำการเปลี่ยนแปลงจำนวนเท่าเดิม

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

private const char FieldSeparator = ';';    // Will become '|' a month from now
private const char RecordSeparator = ' ';
private const int MaxFieldsPerRecord = 10;

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

กำหนดอัฒภาคเป็นคงที่ซ้ำซ้อนเพราะอัฒภาคที่มีอยู่แล้วอย่างต่อเนื่องโดยตัวของมันเอง มันจะไม่เปลี่ยนไปเลย

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

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

การจัดเก็บการตั้งค่าทั้งหมดเป็น const เป็นสิ่งที่ฉันมีความคิดที่สองเกี่ยวกับเช่นกัน เราไม่ควรทำสิ่งนี้เบา ๆ

เราได้รวบรวมตัวอย่างการใช้งานประเภทใดบ้าง Line terminator ... จำนวนการลองซ้ำสูงสุด ... จำนวนล้อสูงสุด ... เราแน่ใจว่าสิ่งเหล่านี้จะไม่เปลี่ยนแปลงหรือไม่

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

นอกจากนี้ยังมีการทดสอบและการเยาะเย้ยด้าน คุณกำหนดสตริงการเชื่อมต่อเป็น const แต่ตอนนี้ oops คุณไม่สามารถจำลองการเข้าถึงฐานข้อมูล (สร้างการเชื่อมต่อปลอม) ในการทดสอบหน่วยของคุณ

private const char SemiColon = ';';
private const char Space = ' ';
private const int NumberTen = 10;

ดังนั้นเพื่อนร่วมงานของคุณตั้งเป้าที่จะเข้าร่วมรายการ WTF รายวัน คำจำกัดความเหล่านั้นโง่และซ้ำซ้อน อย่างไรก็ตามตามที่ได้รับการชี้ให้เห็นจากคนอื่น ๆ คำจำกัดความต่อไปนี้จะไม่โง่หรือซ้ำซ้อน:

private const char StatementTerminator = ';';
private const char Delimiter = ' ';
private const int  BalanceInquiryCode = 10;

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

นอกเหนือจากการอธิบายเจตนาอย่างชัดเจนค่าคงที่เชิงสัญลักษณ์ยังช่วยให้คุณปวดหัวเมื่อคุณสะกดคำผิด การขนย้ายอย่างง่ายจาก "CVS" เป็น "CSV" ในหนึ่งบรรทัดของรหัสได้ผ่านการทดสอบหน่วยและ QA และทำให้เป็นการผลิตซึ่งทำให้การดำเนินการเฉพาะล้มเหลว ใช่เห็นได้ชัดว่าการทดสอบหน่วยและการทดสอบคุณภาพไม่สมบูรณ์และนั่นเป็นปัญหาของตัวเอง แต่การใช้ค่าคงที่เชิงสัญลักษณ์จะช่วยหลีกเลี่ยงอาการแสบร้อนกลางอกเล็กน้อยได้ทั้งหมด

ไม่ควรมีข้อโต้แย้งใด ๆ เกี่ยวกับเรื่องนี้ จุดไม่เกี่ยวกับการใช้ตัวเลขเวทย์มนตร์หรือไม่ประเด็นคือการมีรหัสที่สามารถอ่านได้
พิจารณาความแตกต่างระหว่าง: และif(request.StatusCode == 1) if(request.HasSucceeded)ในกรณีนี้ฉันจะเถียงว่าอันหลังนั้นอ่านง่ายกว่า แต่นั่นไม่ได้หมายความว่าคุณไม่สามารถมีรหัสint MaxNumberOfWheels = 18ได้

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