WordPress Kodlama Standartları

WordPress'in başarılı olmasının nedenlerinden biri açık kaynak yapısıdır : herkes kaynak kodunu görebilir ve projeye katkıda bulunabilir… ve sadece teknik düzeyde değil! Ek olarak, temalar ve eklentiler aracılığıyla genişletilme olasılığı, üçüncü tarafların WordPress'e katılımını da teşvik etti (biz bunun bir örneğiyiz). Ama elbette, herkesin dahil olmasına izin vermenin dezavantajları vardır…

…biri, her programcının kendi programlama stiline sahip olmasıdır. Örneğin, kodu girintilemek için sekmelerin veya boşlukların kullanımı, değişkenler ve işlevler için adlandırma kuralları, koşullu ifadelerin nasıl yazılması gerektiği vb. hakkında sonsuz bir tartışma var.

Herkesin aynı sayfada olmasını nasıl sağlayabiliriz? Tüm geliştiricilerin aynı kural ve ilkeleri izlemesi için bir formül var mı? Dünyanın her yerinden binlerce insan dahil olduğunda tutarlı ve tutarlı bir proje oluşturabilir miyiz?

WordPress Kodlama Standartları Nelerdir?

2004 yılında SitePoint'te yayınlanan bir makalede yazar, kodlama standartlarının ne olduğunu ve neden onlara ihtiyacımız olduğunu net bir şekilde açıkladı. Örneğin, bir kullanıcı adını saklamak için PHP'de bir değişken oluşturmanız gerektiğini düşünün. Adını nasıl koyarsın? $userName ? $username ? $user_name ? Ve takım arkadaşın buna nasıl isim verirdi? Örneğin, Java ile programlamaya başladım, bu yüzden benim için en doğal şey “camel case” ( $userName ) kullanmak olurdu. Ne zaman "yılan davası" ( $user_name ) ile yazılmış bir şey görsem, o kadar korkunç görünüyordu ki!

Gerçek şu ki, hangi seçeneği seçtiğiniz önemli değil – biz sadece “tarzlar” hakkında konuşuyoruz ve burada herkesin kendine ait bir tarzı var. Daha önce de belirtildiği gibi, aynı proje üzerinde çalışan ve her biri kendi stiline sahip birden fazla geliştiricimiz olduğunda sorun ortaya çıkar. Projemizin tutarlı olmasını istiyorsak, herkesin aynı olanı kullanmasına ihtiyacımız var, yoksa bunun gibi bir parça elde edebiliriz:

hemen her çizginin kendine has bir tarzı olduğu yer…

Çözüm

Sorunun çözümü kodlama standartlarını kullanmaktır. Kodlama standardı, geliştiricilerin kodlarını nasıl yazmaları gerektiğini tanımlayan basit bir belgedir . Tüm geliştiriciler kılavuzun önerilerini takip ederse, projemizi stil açısından tutarlı hale getirir ve bozuk bir Frankenstein gibi görünmesini engelleriz.

Tipik olarak, iyi bir kodlama standardı şunları yapmalıdır:

1. Geliştiricileri anlaşılır kod yazmaya teşvik edin
2. Kodu anlaşılır çalışma birimlerinde düzenleyin (örneğin belirli sayıda satırdan fazla olmayan işlevler, paragraflarda düzenleme vb.)
3. Değişken adları, aralık stili için kuralları tanımlayın…
4. Kodu nasıl yorumlayacağınızı açıklayın

İyi bir kodlama standardı tanımlamak kolay değildir. Ancak biraz araştırdıktan sonra, İnternet'te kendi projelerinizde kullanabileceğiniz veya uyarlayabileceğiniz çok sayıda yönerge olduğunu kısa sürede keşfedeceksiniz. Ancak burada WordPress dünyasından bahsediyoruz ve açık kaynak topluluğu olarak bu yönergeleri zaten tanımladık . Onları hala tanımıyorsanız, birazdan onları size tanıtmama izin verin.

WordPress'in Birkaç Kodlama Standardı Vardır

Bir önceki paragrafımdan sizi şaşırtması gereken ilk şey, çoğul olarak “rehberlerden” bahsetmemdir. "Nasıl? WordPress birden çok kılavuzu tanımlar mı? Niye ya?" Çok güzel sorular dostum ? Bildiğiniz gibi, WordPress bir web projesidir ve bu nedenle birden fazla teknoloji kullanır: PHP, JavaScript, HTML ve CSS. Sonuç olarak, her biri için bir kodlama standardımız var: biri PHP dili için, diğeri JavaScript'te yazılan kod için, diğeri HTML'deki web sitelerinin düzeni için ve biri de CSS stilleri için.

Her biri için ayrıntıya girmek niyetinde değilim… her şeyden çok, çünkü ihtiyacınız olan tüm bilgiler kılavuzların kendisinde çok iyi açıklanmış. Burada açıklanan kuralların her biri için ne yapılması ve ne yapılmaması gerektiğine dair açıklayıcı bir örnek bulacaksınız. Bu yüzden onları takip etmekte sorun yaşamazsınız. Ancak uygulamaya başladığımda beni en çok şaşırtan bazı örneklerin altını çizmek istiyorum.

WordPress Kodu Utangaçtır ve Kendi Alanını Sever

WordPress kodlama standartları hakkında beni en çok etkileyen şeyin boşluk kullanımı olduğunu hatırlıyorum. O zamana kadar, kodu oldukça kompakt bir şekilde yazmaya alışkındım:

Ancak, WordPress'te çok fazla alana ihtiyacınız olduğu ortaya çıktı:

Ve sadece PHP'de değil, JavaScript'te de (böylece tüm kodlar tutarlı görünür, bilirsiniz…):

Siz de benim gibiyseniz “bu kadar yer gereksiz” diye düşüneceksiniz. Ama gerçek şu ki, alışınca geri dönmek çok zor! Bu boşluklar kodun nefes almasına ve daha az aşırı yüklenmiş görünmesine yardımcı olarak (bence) daha kolay okunmasını ve anlaşılmasını sağlar.

Yoda Koşulları

Beni güldüren bir diğer şey ise “Yoda koşullarının” kullanılması oldu. Genellikle, koşulları şu şekilde yazmaya alışkınız:

ancak kodlama standardı bize bunu tam tersi şekilde yapmamızı söyler:

değişmezi önce (bu durumda, bir tamsayı) ve ardından değişkeni koymak. Bu küçük değişikliğin nedeni, karşılaştırmayı yanlış yazarsanız (yani iki yerine bir eşittir işareti), PHP yorumlayıcısının bir sözdizimi hatası vermesidir (bir değişmeze bir değişken atamaya çalışıyorsunuz) ve bunu hızlı bir şekilde tanımlayabilirsiniz. bir şeyler yanlış.

Bu arada, kendinize neden “Yoda koşulu” dendiğini sorarsanız, bu örneği okumanız yeterli ve anlayacaksınız?:

Korunabilecek Kod Yazma

Size iyi bir kodlama standardının anlaşılır kod üretimini desteklemesi gerektiğini söylediğimi hatırlıyor musunuz? WordPress bir istisna değildir. Örneğin, PHP'de aşağıdaki gibi bir kod yazabilirsiniz:

ki bu tamamen iyi ve kompakt. Ancak, buradaki diğeriyle karşılaştırıldığında:

ikinci versiyonun anlaşılmasının çok daha kolay olduğu açık, çünkü sade İngilizceye daha çok benziyor. Ne zaman programlama yapıyorsanız ve bir kodu biraz daha uzun ve "ayrıntılı" mı yoksa kısa ve "hack" bir alternatif mi yazacağınıza karar vermeniz gereken bir durumdaysanız, ilk seçeneği seçin: gelecekteki benliğiniz veya takım arkadaşınız geliştiricileriniz takdir edecektir. o.

Dikkat et! Hatırlamanız Gereken Farklılıklar da Var

Son olarak küçük bir uyarı ile bitirelim. Kodlama standartlarının yaratıcıları, onları mümkün olduğunca tutarlı ve tek biçimli hale getirmeye çalışsa da (parantez içindeki boşluk örneğini hatırlayın), aralarında bazı farklılıklar vardır. Örneğin, PHP rehberinde isimlerin “yılan vakası” ile yazılmasını öneriyorlar:

JavaScript kılavuzunda sizden bunu "deve çantasında" yapmanızı istiyorlar:

Bir dil ile diğeri arasındaki bu küçük fark, aşağıdaki gibi "meraklar" yaratır:

PHP'den JavaScript'e değişkenler geçirmek istediğimizde, JavaScript'te olmasını istediğimiz PHP değerleriyle bir nesne tanımlamamıza izin veren wp_localize_script işlevini kullanırız. Bu durumda array tuşlarının PHP için tarif ettiğimiz yönergeleri nasıl takip etmediğini görüyoruz. Bunun nedeni, bu değişkenlerin PHP'de değil JavaScript'te kullanılması amaçlanmış olmasıdır.

Editörünüz Size Yardımcı Olsun

Belki rehberlerin harika olduğunu düşünüyorsunuz ama onları öğrenmeye ne vaktiniz ne de arzunuz var. Sonuçta, bunları kodunuza uygulayıp uygulamamak size kalmış, programcı, değil mi? Pekala, yanılıyorsun! Bunun için kod düzenleyicinize güvenebilirsiniz. ?

Önceki bir gönderide, ortağım Antonio size zarif ve çok yönlü bir kod düzenleyici olan Atom'dan bahsetti. Avantajlarından biri , yazdığınız kodun belirttiğiniz kodlama standartlarına uyup uymadığını otomatik olarak kontrol edecek şekilde yapılandırabilmeniz ve uymuyorsa düzeltebilmeniz için sizi uyarabilmesidir. Söylemeye gerek yok, bu tavsiye sadece Atom'a bağlı değil. Örneğin, onu Vim'de kullanıyorum ve elbette editörünüzü bunun için de yapılandırabilirsiniz.

Şimdi sıra sende dostum. WordPress kodlama standartları hakkında ne düşünüyorsunuz? Onları takip ediyor musun? Editörünüzün size yardım etmesine izin veriyor musunuz? Fikrinizi yorumlarda bırakın ve bunun hakkında konuşalım!

Öne Çıkan Resim Glenn Carstens-Peters tarafından .