Alıştırma - Kodunuzun daha kolay okunmasını sağlamak için boşluk kullanma

10 dakika

Yazdırma ve web tasarımcıları, küçük bir alana çok fazla bilgi yerleştirmenin görüntüleyiciyi bunalttığını anlar. Bu nedenle, izleyicinin çalışmanın öncelikli mesajını kavrama yeteneğini en üst düzeye çıkarmak amacıyla bilgileri bölmek için boşluk veya negatif alanı stratejik şekilde kullanır.

Geliştiriciler bir düzenleyicide kod yazarken benzer bir strateji kullanabilir. Geliştiriciler, anlamı iletmek için boşluk kullanarak kodun amacının netliğini artırabilir.

Boşluk nedir?

“Boşluk” terimi, space bar tarafından üretilen her bir boşluğu, tab tuşu tarafından üretilen sekmeleri ve enter tuşu tarafından üretilen yeni satırları ifade eder.

C# derleyicisi boşluğu yoksayar. Boşluğun nasıl yoksayıldığını ve boşluğu kullanarak netliği en üst düzeye çıkarmayı anlamak için aşağıdaki alıştırmada çalışın.

C# derleyicisi tarafından boşluğun nasıl yoksayıldığını göstermek için kod ekleyin

Visual Studio Code'da boş bir Program.cs dosya açtığınızdan emin olun.

Gerekirse Visual Studio Code'ı açın ve düzenleyicide bir Program.cs dosyası hazırlamak için aşağıdaki adımları tamamlayın:
1. Dosya menüsünde Klasörü Aç'ı seçin.
2. CsharpProjects klasörüne gitmek ve açmak için Klasör Aç iletişim kutusunu kullanın.
3. Visual Studio Code EXPLORER görünümünde Program.cs'ı seçin.
4. Visual Studio Code Seçimi menüsünde Tümünü Seç'i seçin ve delete tuşuna basın.

Aşağıdaki kodu girin:

// Example 1:
Console
.
WriteLine
(
"Hello Example 1!"
)
;

// Example 2:
string firstWord="Hello";string lastWord="Example 2";Console.WriteLine(firstWord+" "+lastWord+"!");

Visual Studio Code Dosyası menüsünde Kaydet'i seçin.
EXPLORER görünümünde, TestProject klasör konumunuzdaki bir Terminali açmak için TestProjesi'ne sağ tıklayın ve Tümleşik Terminalde Aç'ı seçin.
Terminal komut isteminde dotnet run yazın ve Enter tuşuna basın.

Aşağıdaki çıkışı görmeniz gerekir:
```
Hello Example 1!
Hello Example 2!
```
Bu sonucun size kodunuzda boşluk kullanmayı nasıl bildirdiğinize bakmak için bir dakikanızı alır.

Şu iki kod örneği, iki önemli fikri göstermektedir:
- Boşluk, derleyici için bir önem arz etmez. Ancak...
- Düzgün şekilde kullanıldığında boşluk, kodu okuma ve anlama yeteneğinizi artırabilir.
Kodunuzu büyük olasılıkla bir kez yazarsınız, ancak kodu birden çok kez okumanız gerekir. Bu nedenle, yazdığınız kodun okunabilirliğine odaklanmalısınız. Zaman içinde boşluk karakteri, sekmeler ve yeni satırlar gibi boşluğun ne zaman ve nasıl kullanılacağına ilişkin bir fikir edineceksiniz.

İlk yönerge:
- Her bir eksiksiz komut (bir deyim), ayrı bir satıra aittir.
- Tek bir kod satırı uzarsa onu bölebilirsiniz. Ancak bunun için iyi bir nedeniniz varsa, tek bir deyimi birden çok satıra rastgele şekilde bölmekten kaçınmanız gerekir.
- Atama işlecinin sol ve sağ tarafında bire boşluk kullanın.
Mevcut kodunuzu aşağıdaki kodla değiştirin:
```
Random dice = new Random();
int roll1 = dice.Next(1, 7);
int roll2 = dice.Next(1, 7);
int roll3 = dice.Next(1, 7);
int total = roll1 + roll2 + roll3;
Console.WriteLine($"Dice roll: {roll1} + {roll2} + {roll3} = {total}");
if ((roll1 == roll2) || (roll2 == roll3) || (roll1 == roll3)) {
    if ((roll1 == roll2) && (roll2 == roll3)) {
        Console.WriteLine("You rolled triples!  +6 bonus to total!");
        total += 6; 
    } else {
        Console.WriteLine("You rolled doubles!  +2 bonus to total!");
        total += 2;
    }
}
```
Bu kodun çok fazla boşluk içermediğini görebilirsiniz. Bu kod, uygulamalarınıza boşluk ekleme yaklaşımını göstermek için kullanılır. Etkili boşluk, kodunuzun ne yaptığını anlamanızı kolaylaştırmalıdır.

Not

Kod, üç zardan elde edilen toplam değerin Random bir "kazanan" puanı değerlendirmek için kullanıldığı simülasyon zar oyunu geliştirmeye yardımcı olması için sınıfını kullanır. Kod, çift veya üçlü döndürme için ek puanlar sağlar. Boşluk eklemenin avantajını görmek için bu kodu tam olarak anlamanız gerekmez.
Bu kodun okunabilirliğini geliştirmek için boşluğu nasıl kullanacağınızı düşünmek için bir dakikanızı alır.

Bu kodun dikkat edilecek iki özelliği vardır:
- Bu kod örneğinde dikey boşluk yoktur. Başka bir deyişle, kod satırlarını ayıran boş satırlar yoktur. Tümü tek bir yoğun kod listesinde birlikte çalıştırılır.
- Açılış ve kapanış küme ayracı simgeleri { } ile tanımlanan kod blokları birlikte sıkıştırılır ve böylece sınırlarının görsel olarak ayırt edilmesi zorlaşır.
Genel olarak konuşursak, okunabilirliği geliştirmek için benzer veya ilgili şeyler yapacak iki, üç veya dört kod satırı arasında boş bir satır eklersiniz.

Dikey boşluk kullanarak kodunuzun ifadesini oluşturmak özneldir. İki geliştiricinin en çok okunabilen öğeyi veya ne zaman boşluk ekleneceğini kabul etmemiş olması mümkündür. Kendi muhakemenizden yararlanın.
Okunabilirliği geliştiren dikey boşluk eklemek için kodunuzu aşağıdaki gibi güncelleştirin:
```
Random dice = new Random();

int roll1 = dice.Next(1, 7);
int roll2 = dice.Next(1, 7);
int roll3 = dice.Next(1, 7);

int total = roll1 + roll2 + roll3;
Console.WriteLine($"Dice roll: {roll1} + {roll2} + {roll3} = {total}");

if ((roll1 == roll2) || (roll2 == roll3) || (roll1 == roll3)) {
    if ((roll1 == roll2) && (roll2 == roll3)) {
        Console.WriteLine("You rolled triples!  +6 bonus to total!");
        total += 6; 
    } else {
        Console.WriteLine("You rolled doubles!  +2 bonus to total!");
        total += 2;
    }
}
```
Değişkenin bildirimini dice , roll değişkenlerinize değer atamak için kullanılan kod satırlarından ayırmak için ilk boşluk satırınız kullanılır. Bu ayrım, kodunuzda nasıl dice kullanıldığını görmenizi kolaylaştırır.

Sonraki boşluk satırınız, roll değişkenlerinizin bildirimini bildiriminden totalayırır. Üç roll değişkeninizin bildirimini gruplandırma iki şekilde yararlı olur. İlk olarak, ilgili değişkenleri içeren bir kod satırı grubu oluşturur. İkincisi, değişken adları çok benzerdir ve bildirim aynı deseni izler. Bu nedenle, bunları birlikte gruplandırmak, benzerliklere dikkatinizi çeker ve farklılıkları ortaya çıkarmanıza yardımcı olur.

Son olarak, üçüncü boşluk satırınız başka bir ilişkili deyim grubunu iç içe if deyimlerinizden ayırır. ve total yönteminin bildirimini Console.WriteLine() içeren deyim grubu, görünüm yerine amaca göre ilişkilidir. Kodunuz üç zarın elde ettiği toplam değere ve zarın çift mi yoksa üçlü mü içerdiğine odaklanır. Bu satırlar, rulonun sonuçlarını hesaplamanız total ve kullanıcıya raporlamanız gerektiğinden ilişkilidir.

Bazı geliştiriciler, ile totalbildirimi Console.WriteLine() arasına boş bir satır eklemeniz gerektiğini iddia edebilir. Yine, boşluk seçimi en iyi kararınıza bağlı. Hangisinin sizin için daha okunabilir olduğuna karar vermeniz ve bu stili tutarlı bir şekilde kullanmanız gerekir.

Geriye sadece ifade kaldı if . Bunu şimdi inceleyebilirsiniz.

Anahtar sözcüğün altındaki kod satırlarına if odaklanarak kodunuzu aşağıdaki gibi değiştirin:

Random dice = new Random();

int roll1 = dice.Next(1, 7);
int roll2 = dice.Next(1, 7);
int roll3 = dice.Next(1, 7);

int total = roll1 + roll2 + roll3;
Console.WriteLine($"Dice roll: {roll1} + {roll2} + {roll3} = {total}");

if ((roll1 == roll2) || (roll2 == roll3) || (roll1 == roll3)) 
{
    if ((roll1 == roll2) && (roll2 == roll3)) 
    {
        Console.WriteLine("You rolled triples!  +6 bonus to total!");
        total += 6; 
    } 
    else 
    {
        Console.WriteLine("You rolled doubles!  +2 bonus to total!");
        total += 2;
    }
}

Aralığı geliştirmek için açılış ve kapanış küme ayraçlarını kendi satırlarına taşıdığınıza dikkat edin.

{ ve } simgeleri, kod blokları oluşturur. Çoğu C# yapıları için kod blokları gerekir. Bu simgeler, sınırların net şekilde görünür ve okunabilir olması için ayrı bir satıra yerleştirilmelidir.

Ayrıca, kod bloğu simgelerinin ait oldukları anahtar sözcüğün altında hizalanması için tab tuşunun kullanılması da önemlidir. Örneğin, if anahtar sözcüğüyle başlayan kod satırına dikkat edin. Bu satırın altında { simgesi yer alır. Bu hizalama, deyiminin { "ait olduğunu" if anlamayı kolaylaştırır. Ayrıca, son } simge de deyimiyle if birlikte sıralar. Hizalama ve girintileme birleşimi, kod bloğunun nereden başlayıp bittiğinin anlaşılmasını kolaylaştırır.

Bu kod bloğunun içindeki kod satırları, bu kod bloğuna "ait" olduklarını gösteren girintilenir.

İç if deyimi ve deyimiyle ve else bu kod bloklarının içindeki kodla benzer bir desen izlersiniz.

Boşluk eklemeye yönelik bu stil kılavuzu herkes tarafından kabul edilmemektedir. Ancak, kod yazarken bu kılavuzu başlangıç noktası olarak kullanmayı göz önünde bulundurmalısınız. Gelecekte, bu kılavuzdan sapmaya karar verirken kasıtlı olabilirsiniz.

Özet

Bu alıştırmada öğrenilen ana konular:

Kodunuzun okunabilirliğini artırmak için boşluğu sorumlu şekilde kullanma.
Kod parçalarını ayırmak amacıyla boş satırlar oluşturmak için satır beslemeleri kullanma. Tümcecik, benzer olan veya birlikte çalışan kod satırlarını içerir.
Kendi kod satırlarında olması için kod bloğu simgelerini ayırmak amacıyla satır beslemeleri kullanma.
Bir kod bloğunu, ilişkilendirilmiş olduğu anahtar sözcükle hizalamak için tab tuşunu kullanma.
Sahipliği göstermek için bir kod bloğunun içindeki kodu girintileme.

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?