У мене є пакетний файл, який виконує кілька сценаріїв python, які вносять модифікації таблиці.

1. Я хочу, щоб користувачі коментували 1-2 сценарії python, які вони не хочуть запускати, а не видаляти їх із пакетного файлу (тому наступний користувач знає, що ці сценарії існують як варіанти!)

2. Я також хочу додати коментарі, щоб звернути їх увагу конкретно на змінні, які потрібно оновити у файлі Batch, перш ніж вони запускаються. Я бачу, що можу використовувати REM. Але схоже, що це більше для оновлення користувача прогресом після його запуску.

Чи є синтаксис для більш доцільного додавання коментаря?

remКоманда дійсно для коментарів. Він не притаманний нікому після запуску сценарію. Деякі автори сценаріїв можуть використовувати його таким чином замість цього echo, оскільки за замовчуванням пакетний інтерпретатор виводить кожну команду перед її обробкою. Оскільки remкоманди нічого не роблять, друкувати їх можна без побічних ефектів. Щоб уникнути друку команди, префікс її за допомогою @, або, щоб застосувати це налаштування у всій програмі, запустіть @echo off. (Це echo offуникати друку подальших команд; @це уникнути друку цієї команди до вступу в дію налаштування ехо.)

Отже, у своєму пакетному файлі ви можете використовувати це:

@echo off
REM To skip the following Python commands, put "REM" before them:
python foo.py
python bar.py

Використовуйте ::абоREM

::   commenttttttttttt
REM  commenttttttttttt

АЛЕ (як зазначали люди):

• Якщо ви використовуєте вбудований текст, вам потрібно додати &символ:
  your commands here & :: commenttttttttttt
• Всередині вкладеної логіки ( IF/ELSE, FORциклів тощо) використовується, REMтому що ::дає помилку.
• :: може вийти з ладу всередині setlocal ENABLEDELAYEDEXPANSION

Ні, звичайні старі пакетні файли використовують REMяк коментар. ECHOце команда, яка щось друкує на екрані.

Щоб "прокоментувати" розділи файлу, який ви могли використовувати GOTO. Приклад усіх цих команд / прийомів:

REM it starts here the section below can be safely erased once the file is customised
ECHO Hey you need to edit this file before running it!  Check the instructions inside
ECHO Now press ctrl-c to interrupt execution or enter to continue
PAUSE
REM erase the section above once you have customised the file
python executed1.py
ECHO Skipping some stuff now
GOTO End
python skipped1.py
python skipped2.py
:END
python executed2.py

Що я можу сказати? Пакетні файли - це пережиток давно минулих часів, вони незграбні та некрасиві.

Ви можете прочитати більше на цьому веб-сайті .

EDIT: трохи змінив приклад, щоб він містив елементи, які ви, очевидно, шукаєте.

:: замість REM переважно використовувались у дні, коли комп'ютери були не дуже швидкими. Рядок REM'ed читається, а потім ігнорується. :: 'Ед-рядок ігнорується повністю. Це може пришвидшити ваш код у "старі часи". Далі більше після REM вам потрібно пробіл, після :: ви цього не зробите.

І як сказано в першому коментарі: ви можете додати інформацію в будь-який рядок, який відчуєте потребу

SET DATETIME=%DTS:~0,8%-%DTS:~8,6% ::Makes YYYYMMDD-HHMMSS

Щодо пропуску деталей. Розміщення REM перед кожним рядком може зайняти багато часу. Як згадувалося, використання GOTO для пропуску деталей - це простий спосіб пропустити великі фрагменти коду. Обов’язково встановіть: LABEL у точці, у якій потрібно продовжувати код.

SOME CODE

GOTO LABEL  ::REM OUT THIS LINE TO EXECUTE THE CODE BETWEEN THIS GOTO AND :LABEL

SOME CODE TO SKIP
.
LAST LINE OF CODE TO SKIP

:LABEL
CODE TO EXECUTE

Багаторядкові коментарі

Якщо є велика кількість рядків, які ви хочете прокоментувати, то буде краще, якщо ви зможете робити коментарі з кількох рядків, а не коментувати кожен рядок.

Дивіться цю публікацію Роб ван дер Вуд про блоки коментарів :

Пакетна мова не має блоків коментарів, хоча існують способи досягнення ефекту.

GOTO EndComment1
This line is comment.
And so is this line.
And this one...
:EndComment1

Ви можете використовувати GOTOLabel і: Label для коментування блоків.

Або якщо блок коментарів з’являється в кінці пакетного файлу, ви можете написати EXITв кінці коду, а потім будь-яку кількість коментарів для вашого розуміння.

@ECHO OFF
REM Do something
  •
  •
REM End of code; use GOTO:EOF instead of EXIT for Windows NT and later
EXIT

Start of comment block at end of batch file
This line is comment.
And so is this line.
And this one...

Розміщення коментарів в одному рядку з командами: використовувати & :: comment

color C          & :: set red font color
echo IMPORTANT INFORMATION
color            & :: reset the color to default

Пояснення:

&відокремлює дві команди , тому в цьому випадку color Cце перша команда і :: set red font colorє другою.

Важливо:

Ця заява з коментарем виглядає інтуїтивно правильно:

goto error1         :: handling the error

але це неправдиве використання коментаря. Він працює лише тому, що gotoігнорує всі аргументи минулого першого. Доказ простий, і це gotoне підведе:

goto error1 handling the error

Але схожа спроба

color 17            :: grey on blue

не вдалося виконати команду через 4 невідомі аргументи color команді: ::, grey, on, blue.

Він працюватиме лише як:

color 17     &      :: grey on blue

Тож амперсанд неминучий.

Ви можете щось прокоментувати, використовуючи ::або REM:

your commands here
:: commenttttttttttt

або

your commands here
REM  commenttttttttttt

Щоб зробити це в тому ж рядку, що і команда, потрібно додати амперсанд:

your commands here      & ::  commenttttttttttt

або

your commands here      & REM  commenttttttttttt

Примітка:

• Використання :: вкладеної логіки ( IF-ELSE, FORциклів тощо) призведе до помилки. У цих випадках використовуйте REMзамість цього.

Це стара тема, і я хотів би додати тут своє розуміння, щоб розширити знання цієї цікавої теми.

Ключова різниця між REM та :::

REM - сама команда, в той час як :: НЕ.

Ми можемо трактувати :: як маркер, що як тільки CMD-аналізатор стикається з першим непорожнім пробілом у рядку, це це :: маркер, він просто пропустить весь рядок і прочитає наступний рядок. Ось чому REM повинен дотримуватися принаймні порожнього простору, щоб він міг функціонувати як коментар для рядка, в той час як :: не потребує порожнього простору за ним.

Що REM - сама команда, можна найкраще зрозуміти з наступного синтаксису FOR

Основний синтаксис FOR наступний

FOR %v in (set) DO <Command> [command param] 

тут <Command>може бути будь-яка дійсна команда. Отже, ми можемо записати наступний дійсний командний рядок як remкоманда

FOR %i in (1,2,3) DO rem echo %i

Однак ми НЕ МОЖЕТЕ написати наступний рядок, оскільки ::це не команда

FOR %i in (1,2,3) DO :: echo %i

Ви можете додати коментарі до кінця пакетного файлу з цим синтаксисом:

@echo off
:: Start of code
...
:: End of code

(I am a comment
So I am!
This can be only at the end of batch files

Просто переконайтеся, що ви ніколи не використовуєте дужки, що закриваються.

Атрибуції: Лео Гуттірес Рамірес на https://www.robvanderwoude.com/comments.php