Proje Geliştirme ve Kodlama Standartları
Entegre geliştirme ortamı, kod yazmaya gerek kalmadan bir çok işlemi yerine getirebilecek hazır nesneler sunmaktadır. Geliştirme yapacak kullanıcı, bu nesneler sayesinde ihtiyaç duyulan süreç ve form tasarımlarını, kod yazmaya gerek duymadan gerçekleştirebilir. Geliştirme ortamı aynı zamanda, daha özelleştirilmiş kontroller ve işleyişler gerçekleştirmek isteyen geliştiricilerin kendi tasarladıkları senaryoları yürütebilmeleri için de kodlarını yazabilme opsiyonunu geliştiricilere sunmaktadır.
Geliştirme ortamını kullanan birden çok geliştirici olduğunda veya mevcut proje geliştiricisi değiştiğinde, sistemde benimsenmiş belirli bir proje geliştirme ve kodlama standardı mevcut değilse organizasyon bünyesindeki her bir proje, farklı formatlarda, anlaşılması ve yorumlanması mümkün olmayan karmaşık yapılarda olabilir. Organizasyonda bulunan tüm projelerin belirlenen bir formatta geliştirilmesi amacı ile bu başlık altında, geliştirme ortamında oluşturulan projelerde uyulması gereken bazı standartlardan bahsedilecektir.
Çözüm ve Proje İsimlerinin Anlamlı Verilmesi
Entegre Geliştirme Ortamında oluşturulan bir çözümün, altında hangi tip projeleri barındırdığı veya bir projenin ne projesi olduğu bilgileri verilen isimlendirme ile anlaşılabilir olmalıdır. Böylece başka bir geliştirici projeleri incelemek istediğinde veya projeyi geliştiren kişi aradan geçen zamanın ardından geliştirdiği bir projeyi bulmaya çalıştığında, tek tek projeleri açıp ne projesi olduğunu anlamaya çalışarak zaman kaybetmemiş olacaktır.
YANLIŞ KULLANIM
DOĞRU KULLANIM
Harici Bağlantı ve Sorgu İsimlerinin Anlamlı Verilmesi
Geliştirme arayüzünde oluşturulan harici bağlantı isimleri ve süreçlerde kullanılmak üzere oluşturulmuş sorgu isimleri anlamlı olmalıdır. Oluşturulan harici bağlantının, hangi harici kaynak ile yapıldığı veya sorgunun hangi verileri getirdiği bilgisi, verilen isimlendirme ile anlaşılabilmelidir. Böylece aynı bağlantı ve sorgu başka bir nesnede ya da projede kullanılmak istendiğinde anlaşılmaları vakit kaybına sebep olmayacaktır.
YANLIŞ KULLANIM
DOĞRU KULLANIM
Kod Girintileri ve Hizalamalara Dikkat Etme
Geliştirme Arayüzü kod editör ekranlarında yazılan kodlarda methodlar, if-else, try-catch gibi özel bloklar ve değer tanımlamaları arasında bulunan girintilere dikkat edilmelidir. Böylece daha okunaklı ve anlaşılır kod blokları oluşacaktır.
YANLIŞ KULLANIM
DOĞRU KULLANIM
Boşluk Kullanımı
Birden fazla değişken tanımlarken değişken adları arasında virgülden sonra boşluk kullanılması, blok deyimler içerisinde, değişkenler ve operatörler arasında boşluk kullanılması, fonksiyon parametreleri arasında virgülden sonra boşluk kullanılması, kodlarınızın daha okunaklı olmasını ve belirli bir kuralla dahil edilmesini sağlayacaktır.
YANLIŞ KULLANIM
DOĞRU KULLANIM
Blok Açıklama Kullanımları
Blok açıklamaları fonksiyon, modül ya da proje gibi kodların başına, daha sonraki kullanımlara gerekli olabilecek açıklamalar girilmesi için kullanılır. Açıklamalar, çok detaya girilmeden, ilgili kod bloğunun ne iş yaptığı ve gerekli diğer bilgileri içerecek şekilde yazılmalıdır. Blokta herhangi bir değişiklik yapılırsa açıklama alanı mutlaka güncellenmelidir. Açıklama blokları, kodun anlaşılır olması açısından büyük önem taşır.
YANLIŞ KULLANIM
DOĞRU KULLANIM
Tek Satırlık Açıklamalar
Tek satırlık açıklamalar, alt kısımda bulunan kod bloğunu açıklar nitelikte, belirli işlemlerin gerçekleştiği kod bloklarının başına yazılmalıdır.
YANLIŞ KULLANIM
DOĞRU KULLANIM
Satır İçi Açıklama Kullanımı
Satır içi açıklamalar, sadece bulunduğu satırdaki ifadeyi açıklar nitelikte ve sadece o satıra ait bilgileri ifade edecek şekilde kullanılmalıdır.
YANLIŞ KULLANIM
DOĞRU KULLANIM
İsimlendirmelerde Büyük Küçük Harf Kuralları
Özellik ve değişken gibi ögeler isimlendirilirken, kelimenin ilk harfleri küçük, diğer harfleri büyük olacak şekilde isimlendirme yapılır. Sınıf ve method isimlerinde ise ilk harf büyük kullanılır.
YANLIŞ KULLANIM
DOĞRU KULLANIM
Aynı tanımın hem büyük harf içeren versiyonu hem küçük harf içeren versiyonu kullanılmamalıdır.
YANLIŞ KULLANIM
DOĞRU KULLANIM
Türkçe Karakter Kullanımı
Türkçe karakterler kod içerisinde farklı algılanıp hatalara sebep olabileceği için, kod içinde Türkçe karakterler kullanılmamalıdır.
YANLIŞ KULLANIM
DOĞRU KULLANIM
“Return” Kullanımı
Fonksiyonlarda değer döndürürken değişken kullanıp tek bir yerden return edilebilir veya return edilecek değerin oluştuğu yerlerde birden fazla return deyimi kullanılabilir. Ne şekilde return edileceği yazılan fonksiyonun koduna bağlı olarak, karmaşık kod yapılarında değişken kullanımı ve tek bir yerden return tercih edilmelidir. Yazılan fonksiyon değeri switch-case yapısında return edilecekse, değer “case” içerisinden return edilmelidir.
YANLIŞ KULLANIM
DOĞRU KULLANIM
“If-Else” Yapısı Kullanımı
En çok kullanılan kod blokları arasındadır. Genel olarak koşul satırı bitiminden sonraki satırda “{” işareti kullanılmalı ve şart içindeki kodlama bittikten sonra da “}” işareti ile blok kapatılmalıdır.
YANLIŞ KULLANIM
DOĞRU KULLANIM
Karmaşık karşılaştırmalar gerektiren koşullar “if” bloğu içerisine yazılmamalı, her bir koşul bir değişkene atanarak, “if” bloğunda değişkenlerin karşılaştırılması yapılmalıdır.
YANLIŞ KULLANIM
DOĞRU KULLANIM
Veri tipi “bool” olan karşılaştırmalarda direkt olarak karşılaştırma işlemi yapılır. “==” veya “!=” kontrollerinin yeniden işleme sokulmasına gerek yoktur.
YANLIŞ KULLANIM
DOĞRU KULLANIM
Koşul yapılarında gereksiz yere koşulun tersinin de kontrol edilmesi, kod karmaşıklığını artıracağı ve gereksiz kod satırı oluşturacağı için yapılmamalıdır.
YANLIŞ KULLANIM
DOĞRU KULLANIM
İç içe if blokları kullanmak yerine else if yapısı tercih edilmelidir.
YANLIŞ KULLANIM
DOĞRU KULLANIM
“For – Foreach” Yapısı Kullanımı
Bu iki döngü tipinde, döngü içerisinde sadece tek satır kod olsa dahi blok parantezleri mutlaka kullanılır. Ayrıca döngü içerisinde zorunlu kalınmadıkça değişken tanımlanmamalıdır.
YANLIŞ KULLANIM
DOĞRU KULLANIM
“While – do/while” Yapısı Kullanımı
Döngü çıkışı, döngü çıkış deyimi ile kontrol edilir. Mecbur kalınmadıkça döngü içerisinde if kontrolü ile çıkış yapılması önerilmez.
YANLIŞ KULLANIM
DOĞRU KULLANIM
“Try – Catch” Yapısı Kullanımı
Bu yapıda kesinlikle boş bir catch bloğu tanımlanmamalıdır. Catch bloğu, akış kontrol etmek için kullanılmamalı veya değerlendirilemeyen istisnai durum yakalanmamalıdır. Catch bloğu içerisinde başka bir try-catch bloğu kullanılmaz. İstisnai durum yakalanması, en çok yakalanma olasılığı olandan en azına doğru sıralanmalıdır.