Bu üç teknik, kodunuzun okunabilirliğini% 300 oranında artırabilir
Not! Not! İyi bir programcı olmak istiyorsanız, bazı yazılı olmayan kurallara uymanız gerekir. Bu makale algoritmaları, veri yapılarını, yazılım mimarilerini ve programlamayı tartışmıyor, daha basit ve önemli bir şeyi tartışıyor: okunabilirlik.
Kaynak kod, çabalarını ve enerjilerini tüketen programcıların çalışmasıdır, bu nedenle "dağınıklığı hızla kesme" olgusu olmamalıdır. Bu düzenlemeleri görmezden gelmek kod üretimini hızlandırmış gibi görünebilir, ancak aslında bu genellikle çabanın yarısını oluşturur.
Kod bir kez yazılır ve sayısız kez okunur. Bu nedenle, okunabilirliği artırmak için kodu optimize etmek özellikle önemlidir. Okunabilirliği yüksek kod oluşturmaya yardımcı olmak için bu makale, uyulması gereken 3 önemli kuralı özetlemektedir. Bu kurallara uymak, kodu kullanan kişilerin kodu korumasına, genişletmesine ve ayarlamasına yardımcı olabilir. Ayrıca, yüksek oranda okunabilir kod, hatalara daha az eğilimlidir.
Bu üç tekniğin en iyi yanı, hemen uygulanabilmeleridir. Eğitim süresi gerekmez. Daha iyi bir programcı olmak sadece birkaç dakikanızı alır!
Açıklayıcı değişken ve işlev adları kullanın
Program kodu genellikle binlerce kelime içerir. Elbette daha kısa kodlar da var. Kendinden açıklayıcı değişkenlerin ve işlev adlarının kullanılması, kodun okunmasını, anlaşılmasını, sürdürülmesini ve daha sonra genişletilmesini kolaylaştırır. Örneğin:
Bu kodu yazarken, geliştirici tam olarak ne tür bir işlev uygulanacağını bilir. Ama diğerleri anlayabilir mi? İlhama ve kadere bağlıdır. Geliştiriciler bu kodun amacını açıklamak için bir yorum ekleyebilir, ancak açıklayıcı değişken adlarının kullanılması okuyuculara aşağıdakiler gibi ilgili bilgileri daha sezgisel olarak söyleyebilir:
Bak! Şimdi anlamak daha mı kolay? Yalnızca açıklayıcı değişken adlarını kullanarak, okuyucular kodun Fahrenheit'i Santigrat'a dönüştürebileceğini hemen anlayabilirler. Şimdi, yukarıdaki kod işlevini uygulamak için bir işlev tanımlayın ve işlev adı ve parametre adına dayalı olarak okunabilirlik üzerindeki etki derecesini gözlemleyin.
"Kısa versiyon:
"Ayrıntılı ek" versiyonu:
Açıkçası: Değişken ve işlev adlarını belirtmek için yalnızca tek bir harf kullanan "kısa" sürümle karşılaştırıldığında, "ayrıntılar eki" sürümü daha fazla yazma süresi alır.
Ancak, kodun iki sürümünü anlamak ne kadar sürer? Kendinden açıklayıcı kod, okuyucuların kodu anlamaları için çok fazla zaman kazandırmakla kalmaz, aynı zamanda geliştiriciler için çok zaman kazandırır. Program ayrıntılarını değiştirmek veya genişletilmiş programlar yazmak için, geliştiricilerin genellikle birkaç ay önce yazılan kodu gözden geçirmesi gerekir. Sonra şaşkın bir yüzle ekrana baktı: "Ben bir tanrıyım, ne yazdım? Okunabilirliği optimize etmenin herhangi bir yolu, fazladan yazma süresine değer.
Uygun girinti kullanın
Guido van Rossum, tasarladığı Python programlama dilinde girintiyi uygulamaya karar verdiğinden, programlama için Python kullanan okuyucular bu bölümü atlayabilir.
C, C ++, Java, JavaScript, PHP, C #, PHP vb. Gibi geniş bir hedef kitleye sahip başka programlama dilleri kullanıyorsanız, bu tekniği aklınızda bulundurun:
Kodu seviyeye göre girintileyin.
Sekmeler veya boşluklar kullanabilir, alana 3 defa veya 4 defa veya geliştiricinin tercihine göre basılabilir. Programlamada girintinin gerekli olduğunu unutmayın. Bazı JavaScript kodlarını karşılaştırarak daha fazla örnekleyelim. Bu kod:
· 100 ila 110 Fahrenheit derecesini karşılık gelen Santigrat dereceye dönüştürün.
· Dönüştürülen değeri birler basamağına yuvarlayın (veriyi bir tam sayı yapın).
· Tüm çift sayı Celsius değerlerini konsola çıktı olarak verin (bu, tamsayı bölmesinin kalanını döndüren modül operatörü "%" kullanılarak yapılır. Bu nedenle,% 112 =% 1,122 = 0)
Girintisiz sürüm:
Girintili sürüm:
Kodu daha da yapılandırmak için koda bazı boş satırlar eklenmiştir. Bu iki kod parçasından hangisi daha okunabilir?
İşlevleri uygun şekilde kullanın
İşlevleri kullanarak yeniden kullanılabilir kod blokları oluşturabilirsiniz. Bunlar ayrıca kodu daha yapılandırılmış, daha okunaklı ve anlaşılır hale getirebilir. Kodun tekrarlanmasını önleme yeteneği, bir işlevin en önemli özelliğidir.
Hangi programlama dilinin kullanıldığına bağlı olarak işlevlerin (veya sınıfların, modüllerin vb.) Tanımlanması, aynı kod parçasının kod kitaplığında birden çok kez göründüğü artık durumu çözebilir. Aşağıdaki örnek iyi bir örnektir:
Yukarıdaki kod, Fahrenheit değerini ve karşılık gelen Santigrat değerini verir. Açıktır ki, yukarıdaki kodda tekrarlayan kod bölümleri vardır. Bu durumda, bir işlev oluşturmak yukarıdaki işlevi daha hızlı gerçekleştirebilir:
Daha ferahlatıcı, doğru! Kod daha temiz ve daha kısa görünüyor. Dahası, önceki örnekten daha açıklayıcıdır. Bu formül, ConvertAndPrint işlevi tanımlandığında yalnızca bir kez görünecektir. Ya sadece Fahrenheit'i Santigrat'a dönüştürmek istiyor, ancak verileri göstermiyorsanız? Farklı işlevler tanımlanarak elde edilebilir:
Odun var! Bu yöntem, kendi kendini açıklayan kod içeren yapı blokları oluşturur, böylece bu yapı blokları farklı programlama bölümlerinde birden çok yolla tekrar tekrar çağrılabilir.
Bu son mu? Hayır!
Hala kodun çok tekrarladığı bazı yerler var. PrintFahrenheitAndCelsius işlevinin 4 değer girmesi gerekir. Peki sadece 3 değeri dönüştürmek istediğimde ne yapmalıyım? 300 değeri dönüştürmek istediğimde ne yapmalıyım? Elbette daha iyi bir yol var!
Kullanılan programlama diline bağlı olarak, bir fonksiyonun parametre sayısını özetleme yöntemi farklı olabilir. Ancak çoğu geliştirici bu sorunu kapsayıcılar (Matrix veya List gibi) kullanarak çözecektir.
Son değişiklik, işlevi daha üstün hale getirir:
· Daha kısa ve okunması daha kolaydır,
· Daha az kısıtlayıcı ve daha çok yönlü.
