İsimlendirme Standartları

Kodlama standartlarına giriş yaptıktan sonra derslerinin ikinci bölümü olan bu dersimizde isimlendirme standartlarına giriş yapacağız. Bu dersimizde toplam altı tane alt bölümü de öğreneceğiz. Bunları yöntem isimleri, yöntem değiştirgeleri, değişken isimleri, nitelik isimleri, sınıf isimleri ağ kontrollerinin ve ADO.NET değişkenlerinin isimlendirilmesi olarak göreceğiz.

Yöntem İsimleri

Tanım:	Yöntem isimlendirmede "Pascal Casing" işaret düzeneği kullanılır. Pascal Casing'de yöntem isimleri büyük harflerle başlayıp küçük harflerle devam eder. Birden fazla kelimeden oluşan yöntem isimlerinde 1. kelimenin dışındaki kelimelerde baş harfi büyük olarak yazılır, diğer harfler küçüktür. Birden fazla oluşan yöntem isimlerinde, kelimeler arasında "_","-" ... ve benzeri araçlar kullanılmaz.
Örnek:	1. Delete( ) 2. AcceptChanges( )
İstisnalar:	Event handlerlar, bu işaret sistemine bir istisnadır. Microsoft tarafından kullanılan standart aşağıdaki gibidir. “EventiUretenKontrol_EventinTipi()” Örnek: btnSave_Click(object sender, System.EventArgs e), btnSave, event'i üreten web kontrolü, Click de event'in tipidir. Bu standart, event handlerlar dışında kullanılmamalıdır.

Yöntem Değiştirgeleri (Parametre)

Tanım:

Yöntem değiştirgelerini isimlendirmede "Camel Casing" işaret sistemi kullanılır. Camel Casing'de değiştirge isimleri küçük harfle başlayıp küçük harfle devam eder. Birden fazla kelimeden oluşan değiştirge isimlerinde, 1. kelimenin dışındaki kelimelerin baş harfi büyük olur, diğer harfler küçüktür. Birden fazla kelimeden oluşan parametre isimlerinde, kelimer arasında "_", "-" ve benzeri ayraçlar kullanılmaz.

Örnek:

Dispose( bool disposing )
RemoveTaskHierarchyFromSystem(int taskHierarchyID)

Değişken (Variable) İsimleri

Tanım:

Değişken isimlendirmede “Camel Casing” işaret sistemi kullanılır. Camel Casing’de değişken isimleri küçük harfle başlayıp küçük harfle devam eder. Birden fazla kelimeden oluşan değişken isimlerinde, 1. kelimenin dışındaki kelimelerin baş harfi büyük olur, diğer harfler küçüktür. Birden fazla kelimeden oluşan parametre isimlerinde, kelimer arasında "_", "-" ve benzeri ayraçlar kullanılmaz.

Örnek:

SqlTransaction transaction;
int returnValue;

Nitelik (Property) İsimleri

Tanım:

Nitelik isimlendirmede "Pascal Casing" işaret sistemi kullanılır. Pascal Casing’de nitelik isimleri büyük harfle başlayıp küçük harfle devam eder. Birden fazla kelimeden oluşan değişken isimlerinde, 1. kelimenin dışındaki kelimelerin baş harfi büyük olur, diğer harfler küçüktür. Birden fazla kelimeden oluşan parametre isimlerinde, kelimer arasında "_", "-" ve benzeri ayraçlar kullanılmaz.

Örnek:

[class_instance].XxxxxxYyyyy
public String Message
{
    get
    {
        return message;
    }
    set
    {
        message = value;
    }

}
public String LeftMenuUrl
{
    get
    {
        return leftMenuUrl;
    }
    set
    {
        leftMenuUrl = value;
    }
}

Sınıf (Class) İsimleri

Tanım:

Sınıf isimlendirmede "Pascal Casing" işaret sistemi kullanılır. Pascal Casing’de sınıf isimleri büyük harfle başlayıp küçük harfle devam eder. Birden fazla kelimeden oluşan sınıf isimlerinde, 1. kelimenin dışındaki kelimelerin baş harfi büyük olur, diğer harfler küçüktür. Birden fazla kelimeden oluşan sınıf isimlerinde, kelimer arasında "_", "-" ve benzeri ayraçlar kullanılmaz.

Örnek:

public class Job
{
...
}
public class ApplicationPage
{
...
}

Ağ (Web) Kontrollerinin ve ADO.NET Değişkenlerinin İsimlendirilmesi

Tanım:

Ağ (Web) Kontrollerinin ve ADO.NET değişkenlerinin adlandırılmasında "Macar" işaret sistemi kullanılır. Macar işaret sisteminde, değişken isimleri, ilgili nesnenin tipinin kısaltılması ile başlarlar. Örneğin bir buton ağ kontrolü;

"System.Web.UI.WebControls.Button btnSave"

şeklinde tanımlanır. “btn” ön eki, Button sınıfının kısaltmasıdır. Aynı şekilde DataTable, DataSet, SqlCommand ve benzeri ADO.NET değişkenleri de bu yöntemle adlandırılmalıdır. Örneğin bir DataTable;

"DataTable dtPersonnelGeneralInformation"

şeklinde tanımlanır. "dt" DataTable'in kısaltmasıdır.

Tüm Kısaltmaların Listesi:

Button » btn-
TextBox » txt-
DropDownList » ddl-
DataGrid » dg-
Checkbox » chk-
RequiredFieldValidator » rfv-
ListBox » lbox-
Panel » pnl-

DataTable » dt-
DataSet » ds-
DataRow » dr-
SqlCommand » cmd-
SqlDataAdaptor » adp-
SqlConnection » con-

Örnek:

protected DropDownList ddlLandingPage;
protected TextBox txtLoginID;
protected Button btnResetPassword;
protected CheckBox chkActive;
protected RequiredFieldValidator rfvLandingPage;
protected Panel pnlUser;
protected DataGrid dgTasks;

private SqlDataAdapter adpTaskHierarchyListSearch;
private SqlCommand cmdTaskHierarchyListSearch;
private DataTable dtTaskHierarchyPredecessor;
private DataSet dsTaskHierarchyPredecessor;
private DataRow drCustomer;

İsimlendirme Standartları

Üye Girişi