projects:rules
Различия
Показаны различия между двумя версиями страницы.
| Предыдущая версия справа и слеваПредыдущая версия | |||
| projects:rules [2025/03/30 00:43] – [Заголовок] | projects:rules [2025/03/30 00:43] (текущий) – [Заголовок] | ||
|---|---|---|---|
| Строка 4: | Строка 4: | ||
| ===== Заголовок ===== | ===== Заголовок ===== | ||
| <code bash README_style.md> | <code bash README_style.md> | ||
| - | # ---------------------------------------- | ||
| - | # 🌐 Установка локали (глобально для скрипта) | ||
| - | export LANG=en_US.UTF-8 | ||
| - | export LC_ALL=en_US.UTF-8 | ||
| - | # ---------------------------------------- | ||
| - | |||
| - | # ==AUTOEXEC== | ||
| - | # === Название программы === | ||
| - | # Краткое описание (первая строка обязательно без #) | ||
| - | # Подробное описание скрипта: | ||
| - | # - Строки между `===` и первой пустой строкой читаются как help | ||
| - | # - Используется в лаунчере для отображения описания | ||
| - | # - Желательно указывать, | ||
| - | # | ||
| - | |||
| - | # 🧭 Рекомендованная структура скрипта: | ||
| - | # - Блок установки переменных и окружения | ||
| - | # - Обработка аргументов командной строки (если есть) | ||
| - | # - Основная логика | ||
| - | # - Завершение и вывод | ||
| - | # - (опционально) Функции в конце | ||
| - | |||
| - | # 🧩 Комментарии в коде: | ||
| - | # Перед **каждой функцией или важным блоком** обязательно размещать поясняющий комментарий: | ||
| - | # - Что делает эта функция / блок | ||
| - | # - Какие переменные использует и изменяет | ||
| - | # - Есть ли побочные эффекты (удаления, | ||
| - | |||
| - | # 💡 Пример: | ||
| - | # Функция для сжатия образа с выбором метода | ||
| - | compress_image() { | ||
| - | # Аргумент 1: путь к образу | ||
| - | # Использует переменную $compression для выбора метода | ||
| - | ... | ||
| - | } | ||
| - | |||
| - | # 🧼 Форматирование: | ||
| - | # - Использовать отступы в 2 пробела (или единый стиль по проекту) | ||
| - | # - Переменные: | ||
| - | # - Придерживаться стиля имён: short_flag, main_loop, backup_dir и т.д. | ||
| - | |||
| - | # 📎 Дополнительно: | ||
| - | # - Скрипты можно снабжать флагами: | ||
| - | # - Для menu-скриптов рекомендуется оформлять пункты как: `1 - Название`, | ||
| - | # - Все временные файлы сохранять в `$temp_dir`, | ||
| - | |||
| - | # 🛑 Важно: | ||
| - | # Скрипт не обязан быть универсальным — главное, | ||
| - | # При публикации лучше добавить лицензию, | ||
| - | |||
| - | # 🚫 Исключение из лаунчера: | ||
| - | # Для принудительного исключения скрипта из списка автозапуска/ | ||
| - | # используйте маркер: | ||
| - | # # ==DIS/ | ||
| - | # Это отличается от отсутствия `# ==AUTOEXEC==` — | ||
| - | # такой скрипт будет проигнорирован намеренно, | ||
| - | |||
| - | </ | ||
| - | <code bash> | ||
| # ---------------------------------------- | # ---------------------------------------- | ||
| # 🌐 Установка локали (глобально для скрипта) | # 🌐 Установка локали (глобально для скрипта) | ||
projects/rules.1743284615.txt.gz · Последнее изменение: —
