Синтаксис кода

Код является важным элементом технической документации. Markdown предоставляет несколько способов отображения кода, включая встроенный код и блоки кода.

Встроенный код

Базовый синтаксис

Используйте обратные кавычки ` для обрамления кода:

markdown

Это пример `встроенного кода`.
Используйте функцию `console.log()` для вывода информации.

Результат:

Это пример встроенного кода. Используйте функцию console.log() для вывода информации.

Код, содержащий обратные кавычки

Когда сам код содержит обратные кавычки, используйте двойные обратные кавычки:

markdown

``Используйте функцию `console.log()```

Результат:

``Используйте функцию `console.log()```

Обработка нескольких обратных кавычек

markdown

```Код с несколькими обратными кавычками `` ` ``` здесь```

Результат:

Код с несколькими обратными кавычками `` ` здесь```

Блоки кода

Блоки кода с отступом

Используйте 4 пробела или 1 табуляцию для создания отступа:

markdown

    function hello() {
        console.log("Привет, мир!");
    }

Результат:

function hello() {
    console.log("Привет, мир!");
}

Блоки кода с ограждением

Используйте три обратные кавычки ``` или тильды ~~~ для обрамления кода:

markdown

```
function hello() {
    console.log("Привет, мир!");
}
```

Результат:

function hello() {
    console.log("Привет, мир!");
}

Указание языка программирования

Укажите название языка после открывающих ``` для включения подсветки синтаксиса:

markdown

```javascript
function hello(name) {
    console.log(`Привет, ${name}!`);
}
```

Результат:

javascript

function hello(name) {
    console.log(`Привет, ${name}!`);
}

Примеры для распространенных языков программирования

JavaScript

markdown

```javascript
// Пример асинхронной функции
async function fetchData(url) {
    try {
        const response = await fetch(url);
        const data = await response.json();
        return data;
    } catch (error) {
        console.error('Ошибка:', error);
    }
}
```

Результат:

javascript

// Пример асинхронной функции
async function fetchData(url) {
    try {
        const response = await fetch(url);
        const data = await response.json();
        return data;
    } catch (error) {
        console.error('Ошибка:', error);
    }
}

Python

markdown

```python
# Пример определения класса
class Calculator:
    def __init__(self):
        self.result = 0
    
    def add(self, x, y):
        return x + y
    
    def multiply(self, x, y):
        return x * y

# Пример использования
calc = Calculator()
print(calc.add(5, 3))
```

Результат:

python

# Пример определения класса
class Calculator:
    def __init__(self):
        self.result = 0
    
    def add(self, x, y):
        return x + y
    
    def multiply(self, x, y):
        return x * y

# Пример использования
calc = Calculator()
print(calc.add(5, 3))

HTML

markdown

```html
<!DOCTYPE html>
<html lang="ru">
<head>
    <meta charset="UTF-8">
    <title>Пример страницы</title>
</head>
<body>
    <h1>Добро пожаловать в Markdown</h1>
    <p>Это пример параграфа.</p>
</body>
</html>
```

Результат:

html

<!DOCTYPE html>
<html lang="ru">
<head>
    <meta charset="UTF-8">
    <title>Пример страницы</title>
</head>
<body>
    <h1>Добро пожаловать в Markdown</h1>
    <p>Это пример параграфа.</p>
</body>
</html>

CSS

markdown

```css
/* Пример адаптивной верстки */
.container {
    max-width: 1200px;
    margin: 0 auto;
    padding: 0 20px;
}

@media (max-width: 768px) {
    .container {
        padding: 0 10px;
    }
}

.button {
    background-color: #007bff;
    color: white;
    border: none;
    padding: 10px 20px;
    border-radius: 4px;
    cursor: pointer;
}

.button:hover {
    background-color: #0056b3;
}
```

Результат:

css

/* Пример адаптивной верстки */
.container {
    max-width: 1200px;
    margin: 0 auto;
    padding: 0 20px;
}

@media (max-width: 768px) {
    .container {
        padding: 0 10px;
    }
}

.button {
    background-color: #007bff;
    color: white;
    border: none;
    padding: 10px 20px;
    border-radius: 4px;
    cursor: pointer;
}

.button:hover {
    background-color: #0056b3;
}

Bash/Shell

markdown

```bash
#!/bin/bash

# Script example: batch process files
for file in *.txt; do
    if [ -f "$file" ]; then
        echo "Processing $file"
        cp "$file" "backup_$file"
    fi
done

# Function definition
function check_dependencies() {
    command -v git >/dev/null 2>&1 || {
        echo "Git is required but not installed."
        exit 1
    }
}

check_dependencies
echo "All dependencies satisfied."
```

Результат:

bash

#!/bin/bash

# Script example: batch process files
for file in *.txt; do
    if [ -f "$file" ]; then
        echo "Processing $file"
        cp "$file" "backup_$file"
    fi
done

# Function definition
function check_dependencies() {
    command -v git >/dev/null 2>&1 || {
        echo "Git is required but not installed."
        exit 1
    }
}

check_dependencies
echo "All dependencies satisfied."

JSON

markdown

```json
{
  "name": "markdown-tutorial",
  "version": "1.0.0",
  "description": "Markdown Chinese Tutorial",
  "main": "index.js",
  "scripts": {
    "dev": "vitepress dev docs",
    "build": "vitepress build docs",
    "preview": "vitepress preview docs"
  },
  "dependencies": {
    "vitepress": "^1.0.0"
  },
  "author": "Your Name",
  "license": "MIT"
}
```

Результат:

json

{
  "name": "markdown-tutorial",
  "version": "1.0.0",
  "description": "Markdown Chinese Tutorial",
  "main": "index.js",
  "scripts": {
    "dev": "vitepress dev docs",
    "build": "vitepress build docs",
    "preview": "vitepress preview docs"
  },
  "dependencies": {
    "vitepress": "^1.0.0"
  },
  "author": "Your Name",
  "license": "MIT"
}

Расширенные функции блока кода

Показ номеров строк

Некоторые процессоры Markdown поддерживают отображение номеров строк:

markdown

```javascript {1}
// Это строка один
function example() {
    console.log("Привет");
}
```

Выделение строк

Выделите конкретные строки:

markdown

```javascript {2-3}
function example() {
    console.log("Эта строка выделена");  // выделена
    return true;               // выделена
}
```

Показ имени файла

Отобразите имя файла кода:

markdown

```javascript title="app.js"
const express = require('express');
const app = express();

app.get('/', (req, res) => {
    res.send('Hello World!');
});
```

Общие ошибки и решения

1. Несоответствие количества обратных кавычек

markdown

❌ Неверно:
```javascript
function hello() {
    console.log("Привет");
}
``  ← Несоответствие количества обратных кавычек

✅ Верно:
```javascript
function hello() {
    console.log("Привет");
}
```

2. Несогласованный отступ

markdown

❌ Неверно: Блок кода с отступом
    Первая строка (4 пробела)
  Вторая строка (2 пробела)  ← Несогласованный отступ

✅ Верно: Блок кода с отступом
    Первая строка (4 пробела)
    Вторая строка (4 пробела)

3. Неверное имя языка

markdown

❌ Неверно:
```js  ← должно быть javascript
function hello() {}
```

✅ Верно:
```javascript
function hello() {}
```

Список поддерживаемых языков

Общие идентификаторы языков:

Язык	Идентификатор	Пример
JavaScript	`javascript`, `js`	`function(){}`
Python	`python`, `py`	`def function():`
Java	`java`	`public class{}`
C++	`cpp`, `c++`	`#include <iostream>`
C#	`csharp`, `cs`	`public class{}`
Go	`go`	`func main(){}`
Rust	`rust`, `rs`	`fn main(){}`
TypeScript	`typescript`, `ts`	`interface{}`
PHP	`php`	`<?php`
Ruby	`ruby`, `rb`	`def method`
SQL	`sql`	`SELECT * FROM`
HTML	`html`	`<div></div>`
CSS	`css`	`.class{}`
XML	`xml`	`<root></root>`
YAML	`yaml`, `yml`	`key: value`
Markdown	`markdown`, `md`	`# Title`
Bash	`bash`, `sh`	`#!/bin/bash`
PowerShell	`powershell`, `ps1`	`Get-Process`
Dockerfile	`dockerfile`	`FROM ubuntu`

Лучшие практики

1. Выберите подходящий формат кода

markdown

✅ Рекомендуется: Используйте формат встроенного кода для короткого кода
Используйте метод `Array.map()` для обработки массивов.

✅ Рекомендуется: Используйте блоки кода для длинного кода
function processArray(arr) {
    return arr.map(item => item * 2);
}

2. Добавьте правильные комментарии

markdown

✅ Рекомендуется: Включите объяснительные комментарии
```javascript
// Вычислите среднее значение элементов массива
function calculateAverage(numbers) {
    const sum = numbers.reduce((acc, num) => acc + num, 0);
    return sum / numbers.length;
}
```

3. Используйте правильные идентификаторы языков

markdown

✅ Рекомендуется: Ясный идентификатор языка
```typescript
interface User {
    id: number;
    name: string;
}
```

❌ Не рекомендуется: Неясный идентификатор языка
```text
interface User {
    id: number;
    name: string;
}
```

4. Сохраняйте лаконичный код

markdown

✅ Рекомендуется: Показывайте основную логику
```javascript
// Аутентификация пользователя
function authenticate(token) {
    return validateToken(token);
}
```

❌ Не рекомендуется: Слишком много несвязанных деталей
```javascript
// Это длинный код с множеством несвязанных деталей...
```

HTML вывод

Код Markdown преобразуется в HTML:

markdown

`встроенный код`

Преобразуется в:

html

<code>встроенный код</code>

Блок кода:

markdown

```javascript
function hello() {}
```

Преобразуется в:

html

<pre><code class="language-javascript">
function hello() {}
</code></pre>

Практические примеры

Документация API

markdown

## Вход в систему

Отправьте POST-запрос к `/api/login`:

```bash
curl -X POST https://api.example.com/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "password123"
  }'
```

Пример ответа:

```json
{
  "success": true,
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": 1,
    "email": "user@example.com",
    "name": "Zhang San"
  }
}
```

Пример файла конфигурации

markdown

## Конфигурация проекта

Создайте файл `config.json`:

```json
{
  "database": {
    "host": "localhost",
    "port": 5432,
    "name": "myapp"
  },
  "server": {
    "port": 3000,
    "host": "0.0.0.0"
  }
}
```

Обновите скрипты в `package.json`:

```json
{
  "scripts": {
    "start": "node server.js",
    "dev": "nodemon server.js",
    "test": "jest"
  }
}
```

Руководство по установке

markdown

## Настройка окружения

1. Установите Node.js:

```bash
# macOS (используя Homebrew)
brew install node

# Ubuntu/Debian
sudo apt update
sudo apt install nodejs npm

# Windows (используя Chocolatey)
choco install nodejs
```

2. Проверьте установку:

```bash
node --version
npm --version
```

3. Инициализируйте проект:

```bash
mkdir my-project
cd my-project
npm init -y
```

Связанные синтаксисы

Блоки кода с ограждением - Расширенные функции блока кода
Синтаксис акцентов - Форматирование текста
Синтаксис ссылок - Создание ссылок
Экранирование символов - Обработка специальных символов

Практика

Попробуйте создать следующее:

Коллекция примеров кода на разных языках программирования
Учебник по использованию API с кодом запроса и ответа
Руководство по установке с инструкциями командной строки для разных систем
Шаблон файла конфигурации с подробными комментариями

Синтаксис кода ​

Встроенный код ​

Базовый синтаксис ​

Код, содержащий обратные кавычки ​

Обработка нескольких обратных кавычек ​

Блоки кода ​

Блоки кода с отступом ​

Блоки кода с ограждением ​

Указание языка программирования ​

Примеры для распространенных языков программирования ​

JavaScript ​

Python ​

HTML ​

CSS ​

Bash/Shell ​

JSON ​

Расширенные функции блока кода ​

Показ номеров строк ​

Выделение строк ​

Показ имени файла ​

Общие ошибки и решения ​

1. Несоответствие количества обратных кавычек ​

2. Несогласованный отступ ​

3. Неверное имя языка ​

Список поддерживаемых языков ​

Лучшие практики ​

1. Выберите подходящий формат кода ​

2. Добавьте правильные комментарии ​

3. Используйте правильные идентификаторы языков ​

4. Сохраняйте лаконичный код ​

HTML вывод ​

Практические примеры ​

Документация API ​

Пример файла конфигурации ​

Руководство по установке ​

Связанные синтаксисы ​

Практика ​

Синтаксис кода

Встроенный код

Базовый синтаксис

Код, содержащий обратные кавычки

Обработка нескольких обратных кавычек

Блоки кода

Блоки кода с отступом

Блоки кода с ограждением

Указание языка программирования

Примеры для распространенных языков программирования

JavaScript

Python

HTML

CSS

Bash/Shell

JSON

Расширенные функции блока кода

Показ номеров строк

Выделение строк

Показ имени файла

Общие ошибки и решения

1. Несоответствие количества обратных кавычек

2. Несогласованный отступ

3. Неверное имя языка

Список поддерживаемых языков

Лучшие практики

1. Выберите подходящий формат кода

2. Добавьте правильные комментарии

3. Используйте правильные идентификаторы языков

4. Сохраняйте лаконичный код

HTML вывод

Практические примеры

Документация API

Пример файла конфигурации

Руководство по установке

Связанные синтаксисы

Практика