Bloki kodu Markdown

Bloki kodu są niezbędne do dokumentacji technicznej, tutoriali i każdej treści, która zawiera przykłady kodu. Markdown zapewnia kilka sposobów formatowania kodu, od prostego kodu wewnętrznego do pełnych bloków kodu z podświetlaniem składni.

Kod wewnętrzny

Dla krótkich fragmentów kodu w zdaniach używaj pojedynczych znaczników wstecznych:

Użyj komendy `git status`, aby sprawdzić swoje repozytorium.
Funkcja `console.log()` drukuje na konsolę.
Naciśnij `Ctrl+C`, aby zatrzymać proces.

Wynik:

Użyj komendy git status, aby sprawdzić swoje repozytorium. Funkcja console.log() drukuje na konsolę. Naciśnij Ctrl+C, aby zatrzymać proces.

Ogrodzone bloki kodu

Dla wieloliniowego kodu używaj potrójnych znaczników wstecznych:

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

greet("World");
```

Wynik:

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

greet("World");

Podświetlanie składni

Dodaj nazwę języka po otwierających znacznikach wstecznych dla podświetlania składni:

JavaScript

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

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

Python

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

result = calculate_sum(5, 3)
print(result)  # Wynik: 8
```

Popularne identyfikatory języków

Język	Identyfikator	Alternatywa
JavaScript	javascript	js
Python	python	py
Java	java
C++	cpp	c++
C#	csharp	cs
HTML	html
CSS	css
SQL	sql
JSON	json
XML	xml
Shell	bash	sh
TypeScript	typescript	ts
React JSX	jsx
PHP	php
Go	go
Rust	rust
Swift	swift

Ważne uwagi

Ogrodzone bloki kodu to preferowana metoda formatowania kodu w Markdown, ponieważ zapewniają lepsze podświetlanie składni i są szerzej obsługiwane na różnych platformach.

Najlepsze praktyki

1. Zawsze używaj podświetlania składni

❌ Bez podświetlania składni:

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

✅ Z podświetlaniem składni:

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

2. Utrzymuj przykłady kodu skupione

❌ Za dużo niepotrzebnego kodu:

```javascript
// Dużo kodu konfiguracyjnego...
const express = require('express');
const app = express();
const PORT = 3000;

// ... więcej konfiguracji ...

// Właściwy przykład (zagubiony w konfiguracji)
app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});

// ... więcej szablonowego kodu ...
```

✅ Skupione na ważnej części:

```javascript
// Tworzenie prostego endpoint API
app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});
```

Popularne przypadki użycia

Dokumentacja API

Żądanie:

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

{
  "name": "Jan Kowalski",
  "email": "[email protected]"
}

Odpowiedź:

{
  "id": 123,
  "name": "Jan Kowalski",
  "email": "[email protected]",
  "created_at": "2024-01-15T10:30:00Z"
}

Pliki konfiguracyjne

Utwórz plik .env w głównym katalogu projektu:

# Konfiguracja bazy danych
DB_HOST=localhost
DB_PORT=5432
DB_NAME=myapp
DB_USER=postgres
DB_PASSWORD=hasło123

# Klucze API
API_KEY=twoj_klucz_api
SECRET_KEY=twoj_tajny_klucz

Rozwiązywanie problemów

Typowe problemy

1. Kod się nie formatuje: Sprawdź poprawne znaczniki wsteczne
2. Podświetlanie składni nie działa: Sprawdź identyfikator języka
3. Kod psuje układ: Używaj właściwych łamań linii

Uciekanie przed znacznikami wstecznymi

Jeśli musisz pokazać znaczniki wsteczne w kodzie:

Przykład pojedynczego znacznika wstecznego:

• •
  Napisz: `kod`
• •
  Wynik: kod

Przykład potrójnych znaczników wstecznych:

• •
  Napisz: ```blok kodu```
• •
  Wynik: blok kodu

Znaczniki wsteczne w kodzie wewnętrznym:

• •
  Napisz: ``znacznik wsteczny``
• •
  Wynik: znacznik wsteczny

Bloki kodu są niezbędne do dokumentacji technicznej. Używaj ich, aby twoje przykłady kodu były przejrzyste, czytelne i właściwie sformatowane!

Na koniec naucz się o łamaniu linii, aby udoskonalić formatowanie tekstu.