Sihirli dizelerin / sayıların kullanımı [kapalı]

Bu biraz tartışmalı bir konudur ve sanırım programcılar kadar çok fikir var. Ancak bunun uğruna, iş dünyasında (veya iş yerinizde) ortak uygulamaların ne olduğunu bilmek istiyorum.

İş yerimde katı bir kodlama kurallarımız var. Bunun bir bölümü sihirli dizgelere / sayılara ayrılmıştır. (C # için) belirtir:

Kodunda, sembolik sabitleri tanımlamak dışında, sayısal ya da dizgi değişmez değerleri kullanmayın. Sabitleri tanımlamak için aşağıdaki deseni kullanın:

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

İstisnalar var: 0, 1 ve null değerleri neredeyse her zaman güvenle kullanılabilir. Çok sık 2 ve -1 değerleri de sorun yok. Kayıt veya izlemeye yönelik dizeler bu kuraldan muaftır. Değişmezlere, anlamları bağlamdan açık ve gelecekteki değişikliklere tabi olmadığında izin verilir.

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

İdeal bir durum, aşağıdaki durumlarda kodun okunabilirliği / sürdürülebilirliği üzerindeki etkileri gösteren resmi bir araştırma belgesi olacaktır:

• Sihirli sayılar / dizgiler her yerde
• Sihirli dizgiler / sayılar sabit (ya da farklı kapsama derecelerinde) sürekli bildirimlerle değiştirilir - ve lütfen "makul" kullanımı için bana bağırma, herkesin "makul" olduğu konusunda farklı fikirleri olduğunu biliyorum
• Sihirli dizgiler / sayılar fazla miktarda ve olmak zorunda kalmayacakları yerlerde yerleştirilmişlerdir (aşağıdaki örneğe bakın)

Bunu, meslektaşlarımdan biriyle tartıştığımda, şöyle bir sabit ilan edeceğini belirten bilimsel temelli argümanlara sahip olmak istiyorum:

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

Başka bir örnek olacaktır (ve bu da JavaScript’tedir):

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

DOM kimliklerini javascript dosyanızın üzerine yapıştırıyor musunuz, eğer bu kimliği sadece 1 yerde kullanılıyorsa?

Aşağıdaki konuları okudum:
StackExchange
StackOverflow
Bytes Bilişim Topluluğu
Çok daha fazla makale var ve bunları okuduktan sonra bazı desenler ortaya çıkıyor.

Öyleyse benim sorum, kodumuzda sihirli dizeleri ve sayıları kullanmak mıdır? Özellikle mümkünse referanslar tarafından desteklenen uzman cevaplarını arıyorum.

... meslektaşlarımdan biriyle tartıştığım zaman, kim şöyle bir sabit ilan edeceğini gösteriyor:

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

Meslektaşınızla birlikte yapmanız gereken argüman, değişmez bir alan olarak adlandırmak değil, değişmez bir isim seçmekten ibarettir Space.

Diyelim ki kodunuzun işi, noktalı virgülle ( a;b;c) ayrılmış ve kendileri boşlukla ( a;b;c d;e;f) ayrılmış alanları içeren bir kayıt akışını ayrıştırmaktır . Spesifikasyonunuzu kim yazdıysa, sizi bir ay sonra arar ve “yanılıyorduk, kayıtlardaki alanlar boru sembolleriyle ( a|b|c d|e|f) ayrılır” der, ne yaparsınız?

İsim-değeri-değeri şemasında meslektaşınız tercih ediyorsa, değişmezin ( SemiColon = '|') değerini değiştirmeniz ve SemiColonartık gerçekten noktalı virgül olmayan bir şey için kullanmaya devam eden kodla yaşamanız gerekir . Bu kod incelemelerinde olumsuz yorumlara yol açacaktır . Bu hafifler için, hazır bilgi adını değiştirebilir PipeSymbolve geçmesi ve her olay değiştirmek SemiColoniçin PipeSymbol. Bu hızda ';', ilk etapta sadece bir hazırda noktalı virgül ( ) kullanmış olabilirsiniz , çünkü her bir kullanımını ayrı ayrı değerlendirmek zorunda kalacaksınız ve aynı sayıda değişiklik yapacaksınız.

Sabitleri için Tanımlayıcıları açıklayıcı olması gerekir değeri nedir yapar , değer değil ne olduğunu , ve iş arkadaşınız yabani otlar içine sola dönüş yapmıştır en söyledi. Yukarıda açıklanan alan bölme uygulamasında, noktalı virgülün amacı bir alan ayırıcısıdır ve sabitler buna göre adlandırılmalıdır:

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

Bu şekilde, alan ayırıcısı değiştiğinde, tam olarak bir kod satırını, sabitin bildirimini değiştirirsiniz. Değişikliğe bakan biri sadece bir satır görecek ve alan ayırıcısının noktalı virgülden boru sembolüne dönüştüğünü hemen anlayacaktır. Sabit kullandığı için değiştirmesi gerekmeyen kodun kalanı aynı kalır ve okuyucunun başka ne yaptığını görmek için okuyucuyu kazması gerekmez.

Noktalı virgülün sabit olarak tanımlanması gereksizdir, çünkü noktalı virgül zaten kendiliğinden sabittir . Hiç değişmeyecek.

Bir gün birilerinin "terminolojinin değişimini, + şimdi yeni noktalı virgül olduğunu " duyurması gibi bir şey değil ve meslektaşınız sadece sabiti güncellemek için mutlu bir şekilde acele edecektir (bana güldüler - şimdi bakın).

Bir de tutarlılık sorunu var. NumberTenSabitinin herkes tarafından kullanılmayacağını garanti ediyorum (çoğu kodlayıcı aklı dışında değil), bu nedenle ne olması beklenen bir amaç için hizmet etmeyecek. Kıyamet geldiğinde ve "on" global olarak 9'a ölçeklendiğinde, sabitin güncellenmesi hile yapmaz, çünkü sizi hala 10kodunuzda değişmez bir yığınla bırakacaktır , bu yüzden sistem kapsam dahilinde bile tamamen tahmin edilemez hale geliyor "on" un "9" anlamına geldiği devrimci bir varsayımda.

Tüm ayarları mazeret olarak saklamak, benim de ikinci düşüncelerim var. İnsan bunu hafifçe yapmamalı.

Şu ana kadar bu türden kullanım örnekleri neler? Hat sonlandırıcı ... maksimum deneme sayısı ... maksimum tekerlek sayısı ... bunların asla değişmeyeceğinden emin miyiz?

Maliyet, varsayılan ayarların değiştirilmesinin bir uygulamanın yeniden derlenmesini gerektirdiğini ve bazı durumlarda bağımlılıklarının bile (sayısal yapı değerleri derleme sırasında kodlanmış olabileceğinden).

Test ve alaycı yönü de var. Bağlantı dizesini bir const olarak tanımladınız, ancak artık birim testinizde veritabanı erişimiyle (sahte bir bağlantı kurarak) dalga geçemezsiniz.

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

Demek meslektaşın Daily WTF girişi yapmayı hedefliyor. Bu tanımlar aptal ve gereksizdir. Başkaları tarafından işaret edildiği gibi Ancak, aşağıdaki tanımlar olur değil saçma ya da gereksiz olabilir:

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

"Sihirli" sayılar ve dizgiler, gerçek, değişmez değerlerinin ötesinde bir anlam ifade eden sabitlerdir. 10Sabitin "on şeyin" ötesinde bir anlamı varsa (belirli bir işlem veya hata koşulu için bir kod olarak söyleyin), "sihir" haline geldiğinde ve bu soyut anlamı tanımlayan sembolik bir sabitle değiştirilmelidir.

Niyeti açıkça tanımlamanın ötesinde, sembolik sabitler, değişmezi yanlış yazdığınızda size bazı baş ağrılarından da tasarruf sağlar. Tek bir kod satırında "CVS" den "CSV" ye basit bir geçiş, ünite testi ve KG ile tüm yolu ele geçirdi ve belirli bir işlemin başarısız olmasına neden olan üretime soktu. Evet, açıkçası, ünite ve KG testleri eksikti ve bu kendi sorunu, ancak sembolik bir sabit kullanmak, o mide ekşimesi miktarını tamamen önlerdi.

Bu konuda tartışmalı bir şey olmamalıdır. Mesele, sihirli sayılar kullanıp kullanmamakla ilgili değil, nokta okunabilir kodlara sahip olmak.
Ve arasındaki farkı göz önünde bulundurun: if(request.StatusCode == 1)ve if(request.HasSucceeded). Bu durumda, ikincisinin daha okunaklı olduğunu savunuyorum, ancak bu hiçbir zaman böyle bir kodun olamayacağı anlamına gelmez int MaxNumberOfWheels = 18.

Not: Bu yüzden kodlama kurallarından kesinlikle nefret ediyorum. Geliştiriciler bu gibi karar çağrıları yapabilmek için yeterince olgun olmalıdır; Kimin tanrı tarafından oluşturulmuş bir metne bırakmamasını biliyor.