Код IT
← Каталог

Рекомендации по написанию PowerShell-скриптов — Заголовок и метаинформация

Фрагмент из «Рекомендации по написанию PowerShell-скриптов»: Заголовок и метаинформация.

powershell powershellencyclopedia111 embed URL статья в энциклопедии
PowerShell main.ps1
<#
.SYNOPSIS
    Краткое описание назначения скрипта.
    Этот скрипт выполняет резервное копирование директорий с логированием результатов.

.DESCRIPTION
    Подробное описание функционала скрипта.
    Скрипт принимает путь к исходной директории, путь к месту назначения и имя бэкапа.
    Он создает архив в формате .zip и сохраняет список файлов в текстовом файле.
    При возникновении ошибок скрипт выводит сообщение в консоль и файл журнала.

.PARAMETER SourcePath
    Полный путь к директории, которую необходимо скопировать.
    Обязательный параметр.

.PARAMETER DestinationPath
    Полный путь к директории, куда будет сохранен архив.
    Обязательный параметр.

.PARAMETER BackupName
    Имя создаваемого архива (без расширения).
    Необязательный параметр, по умолчанию используется текущая дата и время.

.EXAMPLE
    .\Backup-Scripts.ps1 -SourcePath "C:\Данные" -DestinationPath "D:\Backups" -BackupName "DailyBackup"

.NOTES
    Автор: Система Administrator
    Версия: 1.0
    Дата создания: 2026-04-30
#>
<#
.SYNOPSIS
    Краткое описание назначения скрипта.
    Этот скрипт выполняет резервное копирование директорий с логированием результатов.

.DESCRIPTION
    Подробное описание функционала скрипта.
    Скрипт принимает путь к исходной директории, путь к месту назначения и имя бэкапа.
    Он создает архив в формате .zip и сохраняет список файлов в текстовом файле.
    При возникновении ошибок скрипт выводит сообщение в консоль и файл журнала.

.PARAMETER SourcePath
    Полный путь к директории, которую необходимо скопировать.
    Обязательный параметр.

.PARAMETER DestinationPath
    Полный путь к директории, куда будет сохранен архив.
    Обязательный параметр.

.PARAMETER BackupName
    Имя создаваемого архива (без расширения).
    Необязательный параметр, по умолчанию используется текущая дата и время.

.EXAMPLE
    .\Backup-Scripts.ps1 -SourcePath "C:\Данные" -DestinationPath "D:\Backups" -BackupName "DailyBackup"

.NOTES
    Автор: Система Administrator
    Версия: 1.0
    Дата создания: 2026-04-30
#>