Kendinden Belgelenmiş Kod Okunması ve Bakımı Daha Kolay
En Az Kefaret İlkesi'ni ve belgeleme kodu kodunu izleyin : hem kullanımını kolay anlaşılır kılmak hem de açıklama yapmadan kodun okunmasını kolaylaştırmak için bir hedef için bir değişken kullanın.
Doğru Şekilde Yapılandırılmış Kod (Yeniden) Kullanımından Daha Kolay (Böylece Daha Ucuz)
Ayrıca, burada query
her zaman bir ifadeyi yürütmeden önce bir deyim hazırlamak için kullanılır. Muhtemelen bu kodun bir kısmını sorguyu hazırlamak ve yürütmek ( DRY ilkesine uymak için) için bir (veya daha fazla) yardımcı yöntemde yeniden düzenlemek istediğiniz bir işarettir .
Bu şekilde, etkili bir şekilde şunları yapacaksınız:
- geçerli bağlamın sorgusunu tanımlamak için yardımcı yönteminizde yalnızca bir değişken kullanın,
- her sorguyu yeniden yürütmek istediğinizde daha az kod yazmanız gerekir,
- kodunuzu diğerleri için daha okunabilir hale getirin.
Örnekler:
Örneğin, yeniden düzenlenmiş sürümün daha iyi olduğu örneklerden alınmıştır. Elbette snippet'iniz bu sorunun amacına sadece bir örnekti, ancak kavram hala geçerli ve ölçeklidir.
Örnek 1:
Strings querycre,queryins,queryup,querydel;
querycre = 'Create table XYZ ...';
execute querycre ;
queryins = 'Insert into XYZ ...';
execute queryins ;
queryup = 'Update XYZ set ...';
execute queryup;
querydel = 'Delete from XYZ ...';
execute querydel ;
Örnek 2:
Strings query;
query= 'Create table XYZ ...';
execute query ;
query= 'Insert into XYZ ...';
execute query ;
query= 'Update XYZ set ...';
execute query ;
query= 'Delete from XYZ ...';
execute query ;
Örnek 3 (Yeniden düzenlenmiş sözde kod):
def executeQuery(query, parameters...)
statement = prepareStatement(query, parameters);
execute statement;
end
// call point:
executeQuery('Create table XYZ ... ');
executeQuery('Insert into XYZ ...');
executeQuery('Update XYZ set ...');
executeQuery('Delete from XYZ ...');
Fayda düzenli kullanım ile ortaya çıkar.
Kişisel Anekdot
Başlangıçta sınırlı ekran gayrimenkul ile çalışan bir C programcısı olarak başladım, bu yüzden değişkenleri yeniden kullanmak hem derlenmiş kod (o zamanlar) hem de daha fazla kodun aynı anda okunabilmesini sağlamak için mantıklıydı.
Ancak, daha sonra üst düzey dillere geçtikten ve işlevsel programlamayı geliştirdikten sonra, yan etkileri sınırlamak için mümkün olduğunda değişmez değişkenler ve değişmez referanslar kullanma alışkanlığını aldım.
Bunun içinde benim için ne var?
Tüm işlev girdilerinizin değişmez olmasını ve yeni bir sonuç döndürmeyi (gerçek bir matematiksel işlevde olduğu gibi) alıyorsanız, mağazaları kopyalamama alışkanlığına girersiniz.
Uzantı olarak, bu aşağıdakilere yol açar:
- kısa fonksiyonlar yazıyorsunuz,
- iyi tanımlanmış hedefleri olan,
- anlaşılması daha kolay,
- yeniden kullanmak,
- genişletmek (ister OO mirası ister fonksiyonel zincirleme yoluyla),
- ve belge (zaten kendi kendine belgelendiği gibi).
Burada değişebilir duruma bir faydası olduğunu söylemiyorum, sadece alışkanlığın senin üzerinde nasıl büyüyebileceğini ve kod okunabilirliğini nasıl etkilediğini gösteriyorum.