Markdown Kod Blokları

Kod blokları teknik dokümantasyon, öğreticiler ve kod örnekleri içeren her türlü içerik için gereklidir. Markdown, basit satır içi koddan sözdizimi vurgulaması olan tam kod bloklarına kadar kod biçimlendirmek için çeşitli yollar sunar.

Satır İçi Kod

Cümleler içindeki kısa kod parçacıkları için tek ters tik kullanın:

Deponuzu kontrol etmek için `git status` komutunu kullanın.
`console.log()` işlevi konsola yazdırır.
İşlemi durdurmak için `Ctrl+C` tuşlarına basın.

Sonuç:

Deponuzu kontrol etmek için git status komutunu kullanın. console.log() işlevi konsola yazdırır. İşlemi durdurmak için Ctrl+C tuşlarına basın.

Çerçeveli Kod Blokları

Çok satırlı kod için üçlü ters tik kullanın:

```
function greet(name) {
console.log("Merhaba, " + name + "!");
}

greet("Dünya");
```

Sonuç:

function greet(name) {
console.log("Merhaba, " + name + "!");
}

greet("Dünya");

Sözdizimi Vurgulama

Sözdizimi vurgulaması için açılış ters tiklarından sonra dil adını ekleyin:

JavaScript

```javascript
function calculateSum(a, b) {
return a + b;
}

const result = calculateSum(5, 3);
console.log(result); // Çıktı: 8
```

Python

```python
def calculate_sum(a, b):
return a + b

result = calculate_sum(5, 3)
print(result) # Çıktı: 8
```

Popüler Dil Tanımlayıcıları

DilTanımlayıcıAlternatif
JavaScriptjavascriptjs
Pythonpythonpy
Javajava
C++cppc++
C#csharpcs
HTMLhtml
CSScss
SQLsql
JSONjson
XMLxml
Shellbashsh
TypeScripttypescriptts
React JSXjsx
PHPphp
Gogo
Rustrust
Swiftswift

Önemli Notlar

Çerçeveli kod blokları, daha iyi sözdizimi vurgulama sağladığı ve farklı platformlarda daha geniş destek aldığı için Markdown'da kod biçimlendirmek için tercih edilen yöntemdir.

En İyi Uygulamalar

1. Her Zaman Sözdizimi Vurgulama Kullanın

❌ Sözdizimi vurgulama yok:

```
if (user.isLoggedIn) {
showDashboard();
} else {
showLoginForm();
}
```

✅ Sözdizimi vurgulama ile:

```javascript
if (user.isLoggedIn) {
showDashboard();
} else {
showLoginForm();
}
```

2. Kod Örneklerini Odaklanmış Tutun

❌ Çok fazla alakasız kod:

```javascript
// Çok fazla kurulum kodu...
const express = require('express');
const app = express();
const PORT = 3000;

// ... daha fazla kurulum ...

// Asıl örnek (kurulumda gömülü)
app.get('/api/users', (req, res) => {
res.json({ users: [] });
});

// ... daha fazla standart kod ...
```

✅ Önemli kısma odaklanmış:

```javascript
// Basit bir API uç noktası oluştur
app.get('/api/users', (req, res) => {
res.json({ users: [] });
});
```

Yaygın Kullanım Durumları

API Dokümantasyonu

İstek:

POST /api/users
Content-Type: application/json

{
"name": "Ahmet Yılmaz",
"email": "[email protected]"
}

Yanıt:

{
"id": 123,
"name": "Ahmet Yılmaz",
"email": "[email protected]",
"created_at": "2024-01-15T10:30:00Z"
}

Yapılandırma Dosyaları

Proje kök dizininizde bir .env dosyası oluşturun:
# Veritabanı yapılandırması
DB_HOST=localhost
DB_PORT=5432
DB_NAME=myapp
DB_USER=postgres
DB_PASSWORD=password123

# API Anahtarları
API_KEY=your_api_key_here
SECRET_KEY=your_secret_key_here

Sorun Giderme

Yaygın Sorunlar

  1. Kod biçimlenmiyor: Doğru ters tikleri kontrol edin
  2. Sözdizimi vurgulama çalışmıyor: Dil tanımlayıcısını doğrulayın
  3. Kod düzeni bozuluyor: Doğru satır sonlarını kullanın

Ters Tikleri Kaçırma

Kodunuzda ters tik göstermeniz gerekiyorsa:

Tek ters tik örneği:

  • Yazın: `kod`
  • Sonuç: kod
Üçlü ters tik örneği:

  • Yazın: ```kod bloğu```
  • Sonuç: kod bloğu
Satır içi kodda ters tik:

  • Yazın: ``backtick``
  • Sonuç: backtick
Kod blokları teknik dokümantasyon için gereklidir. Kod örneklerinizi net, okunabilir ve düzgün biçimlendirilmiş hale getirmek için bunları kullanın!

Son olarak, metin biçimlendirmenizi mükemmelleştirmek için satır sonları hakkında öğrenelim.