Если вы пишете сценарии и хотите добавить комментарии между аргументами команды, этот пост может оказаться вам полезным! 😉
На работе я пишу много скриптов для автоматизации команд, таких как Dockerfile, GitLab CI, или просто группы команд для конкретной задачи. . В свои сценарии я люблю добавлять много комментариев, чтобы указать, что делает команда или почему. Иногда я даже добавляю комментарии между его аргументами, так как некоторые из них могут быть непонятны. 🥴
Эти комментарии могут быть очевидны для опытных разработчиков, но я думаю, что они могут помочь читателям, поскольку они могут не обладать такими же знаниями. Это может быть даже я через несколько месяцев или лет, так как я регулярно переключаюсь с одного языка на другой, в зависимости от проекта, над которым я работаю.
К сожалению, комментарии между аргументами многострочной команды различаются от оболочки к оболочке. Поэтому иногда я ищу пример в предыдущем проекте, чтобы прокомментировать команды сценария, который я пишу. 🔎
Чтобы облегчить разработку моих будущих сценариев, я решил написать этот небольшой пост в качестве личной заметки. 📝
Я надеюсь, что это также поможет вам писать лучшие сценарии! Наслаждаться! 😊
Баш
- Обычные комментарии:
# Comment
- Комментарии между аргументами:
`# Comment`
# Downloads the package lists from the repositories and updates them
apt-get update \
# Install the following dependencies with the specified versions
# To check if the versions are up to date: https://packages.debian.org/search?suite=buster&keywords=wget
&& apt-get install --no-install-recommends --no-install-suggests -y \
locales=2.28-10 `# To be able to change the language` \
unzip=6.0-23+deb10u2 `# To be able to unzip the source files` \
wget=1.20.1-1.1 `# To be able to obtain the source files`
PowerShell
Выдержка из моего поста Сценарии Lint PowerShell с PSScriptAnalyzer.
- Обычные комментарии:
# Comment
- Комментарии между аргументами:
<# Comment #>
# Sets values for a registered module repository
Set-PSRepository \
-ErrorAction Stop <# Action to take if a command fails #> \
-InstallationPolicy Trusted <# Installation policy (Trusted, Untrusted) #> \
-Name PSGallery <# Name of the repository #> \
-Verbose; <# Write verbose output #>
Эта статья была изначально опубликована на сайте www.benjaminrancourt.ca 11 марта 2021 г.