Web Projelerinde Dosya ve Klasör Yapısı

Bütün işlerimizde olduğu gibi web projelerini geliştirirken de belli bir düzen dahilinde çalışmak verimliliği arttıran önemli unsurlardan biridir. Herkesin kendine özgü bir düzeni bulunmakta ve kimi zaman kendimize göre en iyi düzeni yakalamak çok uzun zaman alabiliyor. Hatta bana göre bu süreç durağan bir süreç değil. Çünkü devamlı daha iyi bir düzen seviyesi yakalamak istiyoruz.

Şahsen ben öyleyim. Devamlı olarak yeni yöntemler keşfederek mevcut düzenimi daha iyiye yönelik geliştiriyorum. Yani şimdiki yöntemimi belkide bir dahaki yıl daha farklı bir biçimde kullanmış olacağım. :) Yine de bu yazımda hali hazırda kullanıyor olduğum mevcut geliştirme düzenimi sizinle paylaşmam yerinde olacağını düşünüyorum.

Projenin Klasör Yapısı

Klasör yapısı web projelerindeki düzeni oluşturmamızı sağlayan önemli etkenlerden biridir. Klasör yapısı ne kadar karmaşık olursa projelerimizi geliştirmek bir o kadar zor olacaktır. Hele bir de ofis çatısında takım olarak çalışıyorsanız işler iyice karmaşık bir hal alabilir. Bu sebepten dolayı takımınızın benimseyeceği, ortak olarak kullanabileceğiniz, akıllı bir şekilde standart klasör yapısını oluşturmanız iyi olacaktır.

Web projelerinde benim oluşturduğum ve kullanıyor olduğum klasör yapım ve açıklamaları aşağıda yer almakta:

Klasör isimlerini İngilizce olarak oluşturdum çünkü XHTML KITCHEN‘da artık yabancılara da hizmet vermeyi planlıyoruz. Siz kendi ihtiyaçlarınıza göre klasör isimlerini Türkçe’de yazabilirsiniz.

İsterseniz yukarıdaki klasör yapısını şablon olarak indirip siz de kendi çalışmalarınızda kullanabilirsiniz.

Projenin Dosya Yapıları

Projelerimizdeki klasör yapısının düzenli olmasının yanısıra dosyalarınızın da düzenli olması tutarlılık ve verimlilik açısından gayet önemli. Bunun için xHTML ve CSS dosyalarınız için size ayrı başlıklar altında tavsiyelerde bulunacağım.

xHTML Dosyaları İçin Tavsiyelerim

• Kodlarınızı TAB tuşunu kullanarak girintili biçimde yazmaya özen gösterin. Girintili kodları okumak daha kolaydır.
• Sayfanızdaki önemli bölümleri xHTML‘de kullanılan yorum etiketi yani <!--YORUM--> ile gruplandırın.
• Beyaz boşluğu en iyi şekilde ayarlayın. Ben genelde xHTML dosyalarımdaki önemli bölümleri yorumlarla ayırmamın yanısıra bir de birer satır boşluk bırakarak ayırmaya çalışırım. Yine okunabilirlik açısından bunu yapıyorum.
• Etiketlere id ve class verirken mantıklı bir isimlendirme yöntemi ile verin. Ben ecnebilerin CamelCase diye tabir ettikleri türde kelimeleri birleşik yazıyorum. Örneğin: <div id="mainContent"></div>. Bunun yanısıra alt çizgi ve tire ile de isimlendirme yapabilirsiniz (yani _ ve - karakteri ile). Örneğin: <div id="main_content"></div> veya <div id="main-content"></div>.

Unutmadan örnek olarak hazırladığım xHTML dosyasının kodunu inceleyebilir ve üstteki tavsiyelerle karşılaştırma yapabilirsiniz.

CSS Dosyaları İçin Tavsiyelerim

• CSS dosyanızın başında hazırladığım örnekteki gibi müşteri ile ilgili isim, editör adı ve tarih/saat gibi bilgiler yerleştirin. Böylece kimin hangi dosyayı ne zaman kim için düzenlediğini belirlemiş olursunuz.
• Yine örnekte görebileceğiniz üzere önemli bölümler için yorumları kullanarak gruplandırma yapabilirsiniz. İşin bu kısmında dikkat ederseniz grup başlıklarında eşittir işareti bulunmakta. Bununla kullandığınız editör ile arama yaparken gruplar arasında kolayca geçebiliyoruz. Kısacası bu eşittir işaretini kullanarak grup adları ile kodlar karışmamış oluyor.
• Web projesindeki sayfaların herhangi bir yerinde kullanılabilecek önemli CSS komutlarını class haline getirip kullanıma hazırlayın. Hazırladığım örnekte Global Classes grubu altında kullanıma hazır 11 tane class vardı.
• Seçici adından önce (yani selector’dan önce) xHTML etiketini yazın. Örneğin: div#header { ... }. Böylece bu kodun xHTML dosyasında hangi etiket için yazılmış olduğunu kolayca görüp anlayabileceğiz.
• Her CSS kodunu tek satırda yazın. Bu CSS dosyanızın boyutunu azaltmakla kalmaz, kodları gözünüzle çok daha rahat tararsınız.
• Daha önce xHTML dosyaları için bahsettiğim TAB tuşu ile girinti oluşturma yöntemini CSS dosyalarınızda da kullanmalısınız.
• Yine daha önce xHTML dosyaları için bahsettiğim beyaz boşluğu iyi ayarlama yöntemini CSS dosyalarınız için de kullanabilirsiniz. Ben CSS dosyalarımda her gruptan sonra üç satırlık boşluk bırakıyorum. Bu da kodları daha okunabilir yapıyor.

Yine örnek olarak hazırladığım CSS dosyasını inceleyebilir ve üstteki tavsiyelerle karşılaştırma yapabilirsiniz.

Benim bilmediğim ve burada yazmadığım, sizin bildiğiniz bu tip güzel tavsiyeleriniz varsa onu yorum yazıp bu yazıya katkıda bulunabilirsiniz.