Yazılım İsimlendirme Standartları

Bir yazılım yaparken isimlendirme aslında, projenin başlangıcında bir standart seçilip ona göre yapılması projenin daha okunaklı ve kullanışlı olacaktır.

Projeye daha sonradan katılan yada bakım için başka bir yazılımcı  devralması durumunda önceki yazılımcı diye başlayan cümle kurmaması için isimlendirme çok önemlidir.

Ben Microsoft. Net isimlendirme standartları esas alarak aşağıdaki bilgileri paylaşacağım. Database düzeyinde ise oracle yaklaşımı esas teşkil etmiştir.

İsimlendirme Tipleri

Yazılım dünyasında genel kabul görmüş isimlendirme standartları.

1. Pascal İsimlendirme Sistemi

Tanımlayıcıyı oluşturan tüm kelimelerin ilk harfleri büyük harf olarak yazılır. (İlk kelime dahil).

Örnek :

HesaplamaMatrisi;

2. Camel İsimlendirme Sistemi

Tanımlayıcıyı oluşturan tüm kelimelerin – ilk kelime hariç - ilk harfleri büyük olur.

Örnek :

tatilGunu;

3. Büyük Harf

Tüm harfler büyük olur. Kelimeler arasına “_” karakteri eklenir.

Örnek :

ID, PI,HESAP_PLAN

4. Macar (Hungarian) İsimlendirme Sistemi

Diğer adıyla “Tipe Bağlı İsimlendirme”.

Eskiden çok sık kullanılan Macar isimlendirme sistemi, bütünleşmiş geliştirme ortamları (IDE) ve yazılım geliştirme editörlerinin gelişmesiyle artık pek kullanılmamaktadır. Macar isimlendirme sisteminde değişken tipi, değişken ismine ön ek olarak eklenir. Böylece değişken kullanılırken değişken tipi kolayca tahmin edilir ve olası hatalar önlenir.

Yazılım İsimlendirmesi

Ben isimlendirme kısmında genel olarak Pascal ı tercih ediyorum. Tabi projenin tamamında Pascal ın dışına çıktığımız zamanlarda oluyor fakat genel standardımız Pascal dır. Sizde sizin uygun olan hangi standart ise onu kullanabilirsiniz.

.Net ortamında yazılım kodlamada kullanılacak isimlendirmeler aşağıdaki gibi olabilir.

Class

Pascal notasyonu uygulanır.

Public class Musteri{

Public string Ad{

Get{}

Set{}

}

.
.

}

Main(){

Musteri musteri= new Musteri ();

musteri.Ad = “Metin”;
} gibi…

Interface

Paskal notasyonu kullanılır. İsmin başına ‘I’  getirilir. IPersonel gibi

      Private int kullaniciId; Camel

      Public string AdSoyad; Pascal

      Private long[] personels; dizin seklindekilerde “s” takısı getirilir. Veya laPersonel(local array) ve lstPersonel (list) gibi

Sabit

Pascal notasyonu kullanılır.

      Const double OdemeTutar;

Property

Pascal notasyonu kullanılır.

String ad;

Public string Ad{

 Get {return ad; }

Set {ad = value; }

} gibi…

Fonksiyon

İsimlendirmesinde pascal notasyonu kullanılır. İsimlendirmede mutlaka bir oluş ifade edilir. Ve sonda ifade edilir.

Public int PersonelSay(int bolum); gibi parametreler camel kullanılır

Arayüz İsimlendirme

Arayüz objelerinin(textbox,combobox,...) isimlendirmeleri burasıda çok önemli. Önkod olarak kısaltma yazılır daha sonra Pascal notasyonu ile devam edilir.

• Textbox txtAdSoyad,
• CheckBox chkSec,
• Label lblAdSoyad,
• ComboBox cmbBirim,
• DataSource srcPersonel,
• GridView grd

 Diğer objelerde isimlerin baş harfleri ile isimlendirme yapılmaktadır.

• DataTable dtPersonel,
• Dataset dsPersonel,
• DataList dlPersonel,
• ListView lwPersonel,
• FileUpload fuResim,

DB İsimlendirme

Burda ki isimlendirmede ek kullanılmadan isimlendirmek daha okunaklı ve doğru olacaktır.
Örnek; bitistarihi yerine bitistarih demek daha doğru olur.

Tablo

MH_FIS_DETAY gibi modülün ön kodu verilerek tablo isimlendirmesini yapıyoruz.(iki karekter).

Büyük harf notasyonu.Tabi 20 karakteri geçen isimlendirmelerde ise kısaltma kullanılmalıdır.

MH_F_H_MUSTERI_ALACAK gibi // fiş hesap musteri alacak

View

MH _FIS_PERSONEL_VW gibi ismin sonuna + VW+ koyarak tipini belirtiyoruz.

Key

MH _HESAP_PK Primary key

MH _HESAP_IK2 index key

MH _HESAP_UK4 unique key          

MH _HESAP_FK 3 foreign key

Modül kodu + tablo adı+  key tip + sırano + buyuk harf notasyonu

Function

 Anlamlı yapılan işlemi ifade eden isim kullanılır.

  function MH _FIS_OLUSTUR (

  P_HESAP_KOD number,

  P_DUZEY char

begin

  declare

    L_BASLANGIC_TARIH    varchar2(11);

    L_BORC      long; gibi ...

Peki Hangisini Kullanmalı?

Herkes kendine en yakın bulduğu standardı kullanmalıdır. Sonradan dahil olduğumuz projede hangi standart kullanılmış ise ona devam edilmesi daha uygundur.

Standart kullanmak hem bizim için hemde sonraki yazılımcı için büyük kolaylık sağlayacaktır kodun okunabilirliği ve anlaşılması için.

kendime notlar...