İsimlendirme Standartları 2

Açıklamalar

Tanım:

Açıklamalar yazılan kodun daha anlaşılabilir hale gelmesini sağlayan metinlerdir. Amaç, her satıra bir açıklama yazmak değil, birbirinden mantıksal olarak ayrılan kümeleri belli etmek, istisnai kullanımların belirtilmesi ya da eksik yapılan kısımların ileride geri çalışması yapıldığında hatırlatılmasını sağlamaktır.

Açıklama Türleri:

1. C# uygun olarak, her yöntemin başına yöntemi ve değiştirgeleri açıklayan yorumlar yazılmalıdır:

/// <summary>
/// remove the task hierarchy from the system. delete
/// all rows related to this taskHierarchyID.
/// </summary>
/// <param name="taskHierarchyID">
/// taskHierarchyID
/// </param>
/// <returns>true if the task hierarchy is removed,
/// false otherwise
</returns>
public bool RemoveTaskHierarchyFromSystem(int taskHierarchyID)

2. Kodunuzda mantıksal olarak ayrılan kümeler varsa eğer, bunlar arasında bir satır boşluk koyup, her kümenin başına bu kümede yapılan işi tanımlayan bir açıklama eklemek, kodunuzun okunabilirliğini arttırır. Aşağıdaki örnekte, iki küme birbirlerinden bir satır boşlukla ayrılıp, açıklanmıştır.

//add a new row to task hierarchy general information table
DataTable dtTaskHierarchyGeneralInformation = dsTaskHierarchy.Tables["TaskHierarchyGeneralInformation"];
dtTaskHierarchyGeneralInformation.Rows.Add(dtTaskHierarchyGeneralInformation.NewRow());

//add the default starting row to the taskhierarchytotask table
DataTable dtTaskHierarchyToTask = dsTaskHierarchy.Tables["TaskHierarchyToTask"];
DataRow newRow = dtTaskHierarchyToTask.NewRow();
newRow["FK_TaskHierarchyID"] = DUMMY_ID;
newRow["FK_TaskID"] = DUMMY_ID;
newRow["TaskDuration"] = 0;
newRow["TaskParentTaskID"] = DUMMY_ID;
newRow["IsStartupTask"] = true;
newRow["IsParentTask"] = true;
dtTaskHierarchyToTask.Rows.Add(newRow);

3. C#’ta “//” ve “/* */” olmak üzere iki tip açıklama vardır. İlki tek satırda açıklama yapmaya izin verirken, ikincisi birden fazla satırda açıklama yazmanıza izin verir. Dikkat edilmesi gereken, açıklamanızı bir satırı aşıyorsa her satır için “//” kullanmak yerine, iki açıklama satırını birleştirerek “/* açıklama */” içinde birleştirmek daha iyidir.

Örnek:

// Açıklamam 2 satır sürüyor. Birinci satırı burdan başlıyor
// İkinci satır burdan devam ediyor

yerine

/*
*comment’im 2 satır sürüyor. Birinci satırı burdan başlıyor
*İkinci satır burdan devam ediyor
*/

kullanmak gerekir.

4. Visual Studio türü kaliteli IDE’ler ve düzenleyiciler standart C# açıklamalarına fazladan özellikler de eklemiştir. Mesela “//TODO:” şeklinde başlayan bir açıklama, Visual Studio’nun Tasks panosunda otomatik olarak gösterilir.

Örnek olarak; program içinde yeniden gözden geçirilmesi gereken bir kod parçasını belirtmek için, aşağıdaki açıklamayı ekleyelim.

//TODO : Bu bölüm eksik. Task hierarchy'nin projelerle iliskilendirilmesinden sonra tamamlanabilir – uozturk » Not: bu açıklama tek satırda yazılmalıdır.

Eğer Visual Studio’nun View > Show Tasks > Comment menusunu seçerseniz, yazdığınız açıklamayı aşağıdaki şekilde görebilirsiniz.

Geriye yönelik çalışmalarınızı bu şekilde kontrol etmek, yapmanız gerekenleri değişik dosya, kağıt... vb lerine yazarak kontrol etmekten çok daha kolaydır. Kağıt, dosya kaybedilebilir. Ama kod üzerine yazdığınız bu özel açıklamalar her zaman kalıcı ve hatırlatıcıdır.

Kullanıcıdan Alınan Girdilerin Değerlendirilmesi

Tanım:

Kullanıcıdan alınan girdi doğruluğunun kontrol edilmesi, hem uygulamanın düzgün çalışmasını, hem de kötü niyetli saldırganların, uygulamanın güvenliğini tehdit etmesini engeller. Özellikle ağ uygulamaları masaüstü uygulamalarına göre, SQL Injection, Cross Site Scripting vb saldırılara karşı daha açıktır.

Ayrıntılı bilgi için:
1. http://www.sitepoint.com/article/sql-injection-attacks-safe,
2. http://www.cgisecurity.com/articles/xss-faq.shtml

Neyse ki, ASP.NET ağ kontrolleri bir çok onaylamayı bizim için yapmaktadır. ASP, ve JSP programlamaya göre bize daha az görev düşmektedir. Ancak QueryString ile gönderilen değiştirgeler için böyle bir kontrol bulunmamaktadır.

Mesela;

http://localhost/CustomTracker/administration/customerdetails.aspx?id=12

URL’si, 12 değerini taşıyan “id” adlı bir değiştirgeyi kullanıcadan almaktadır. Bu ID otomatik olarak list sayfasından gönderilebilse de kullanıcı isterse burdaki değeri değiştirebilir ve bu URL’yi tekrardan çalıştırabilir. Programcının yapması gereken

1. Değiştirgenin QueryString içinde olup olmadığını
2. Eğer QueryString içinde varsa istenilen biçimde olup olmadığını kontrol etmek.

Yukarıdaki örnekte ilk olarak “id” değiştirgesinin varlığını, ardından da bu “id”nin mutlak tamsayı olup olmadığını kontrol etmek gerekir. Bu kontrollerin ikincisi daha büyük önem taşımaktadır. İlkinde en azından bir değiştirge yokken, ikincisinin eksikliğinde veritabanımız tehdit altındadır. Yukarıda adı geçen referansların okunması, tehditin boyutlarını anlamak açısından önemlidir.

Gereksiz "Sınıf Örnekleri" Kullanımından Kaçınmak

Tanım:

Yaratılan her değişken, ya da sınıf örneği içinde bulunduğu küme sonlanana kadar bellek içinde yer tutar. Buna o değişkenin etki alanı denir.

Mesela:

for(int i = 0;i < dtTemplateList.Rows.Count;i++)
{
int templateID = (int)dtTemplateList.Rows[i] ["TemplateIDSel"];
...
}

Yukarıdaki örnekte templateID'nin etki alanı "for döngüsü"nü kapatan "}" parantezdir. Bu parantez kapandıktan sonra templateID, yokedilmek üzere garbage collector’a teslim edilir.

if(multipleRows.Length > 1)
{
StringBuilder taskName = new StringBuilder();
...
}

örneğinde ise taskName nesnesi "if" kümesi sonlanana kadar bellekte tutulur.

Bu örnekleri daha derinleştirmek mümkün, ama esas konumuza gelirsek hatalı sayılabilecek bir kullanım ise aşağıda gibidir:

if (condition)
{
   String value = (new Xxxxx()).GetSomething(param); »1
   DataSet dsSomething= new DataSet();
   (new Xxxxx().GetAnotherThing(param); »2
   ddlAnyWebControl.DataSource =( new Xxxxx()).GetList();
»3   ....
}

Yukarıdaki örnekte, “Xxxxx” adlı classın aynı scope’a sahip 3 tane örneği yaratılmıştır. “if” kümesi bitene kadar bunlar bellekte yer kaplar.

Bunun yerine kod aşaığdaki şekilde düzenlenerek,

if (condition)
{
   Xxxxx classInstance = new Xxxxx();
   String value = classInstance.GetSomething(param);
   DataSet dsSomething= new DataSet();
   classInstance.GetAnotherThing(param);
   ddlAnyWebControl.DataSource = classInstance.GetList();
   ....
}

hem bellek yönetimine yardımcı olmak hem de kodun okunabilirliğini kolaylaştırmak amacıyla ilgili instance tek bir değişkene atanabilir ve ilerideki kullanımlarda aynı örnek kullanılarak, yenilerinin yaratılması önlenmiş olur.

İsimlendirme Standartları 2

Üye Girişi