Вбудовані коментарі до Bash?

Я хотів би мати можливість прокоментувати один прапор в однорядковій команді. Баш, здається, має лише from # till end-of-lineкоментарі. Я дивлюся на хитрощі, як:

ls -l $([ ] && -F is turned off) -a /etc

Це некрасиво, але краще, ніж нічого. Чи є кращий спосіб?

Наступне, здається, працює, але я не впевнений, чи є він портативним:

ls -l `# -F is turned off` -a /etc

Мої переваги:

Коментуючи сценарій Bash

Це матиме певні накладні витрати, але технічно це відповість на ваше запитання

echo abc `#put your comment here` \
     def `#another chance for a comment` \
     xyz etc

А конкретно для трубопроводів є більш чисте рішення, без накладних витрат

echo abc |        # normal comment OK here
     tr a-z A-Z | # another normal comment OK here
     sort |       # the pipelines are automatically continued
     uniq         # final comment

Як поставити коментар до рядка для багаторядкової команди

Я вважаю найпростішим (і найчитабельнішим) просто скопіювати рядок і прокоментувати оригінальну версію:

#Old version of ls:
#ls -l $([ ] && -F is turned off) -a /etc
ls -l -a /etc

$(: ...) трохи менше потворно, але все ж не добре.

Як щодо зберігання його у змінній?

#extraargs=-F
ls -l $extraargs -a /etc

Ось моє рішення для вбудованих коментарів між декількома командними конвеєрами.

Приклад коментованого коду:

    #!/bin/sh
    cat input.txt \
    | grep something \
    | sort -r

Рішення для коментаря до труби (за допомогою функції помічника):

    #!/bin/sh
    pipe_comment() {
        cat - 
    }
    cat input.txt \
    | pipe_comment "filter down to lines that contain the word: something" \
    | grep something \
    | pipe_comment "reverse sort what is left" \
    | sort -r

Або якщо ви віддаєте перевагу, ось те саме рішення без допоміжної функції, але це трохи менше:

    #!/bin/sh
    cat input.txt \
    | cat - `: filter down to lines that contain the word: something` \
    | grep something \
    | cat - `: reverse sort what is left` \
    | sort -r

Більшість команд дозволяють аргументуватись в будь-якому порядку. Просто перемістіть коментовані прапори до кінця рядка:

ls -l -a /etc # -F is turned off

Потім, щоб увімкнути його, просто скаментуйте та видаліть текст:

ls -l -a /etc -F

Якщо ви знаєте, що змінна порожня, ви можете використовувати її як коментар. Звичайно, якщо він не порожній, він зіпсує вашу команду.

ls -l $ {1 # -F вимкнено} -a / тощо

§ 10.2. Параметр Заміна

Для відключення частини команди, як-от a && b, я просто створив порожній скрипт, xякий знаходиться на шляху, так що я можу робити такі речі, як:

mvn install && runProject

коли мені потрібно будувати, і

x mvn install && runProject

коли ні (використання Ctrl + Aта Ctrl + Eперехід до початку та кінця).

Як зазначається в коментарях, інший спосіб зробити це вбудований Bash :замість x:

$  : Hello world, how are you? && echo "Fine."
Fine.

Якщо коментар варто зробити, він, ймовірно, може пройти в кінці рядка або самостійно. Я рідко знаходжу необхідність у внутрішніх коментарях з кодом до та після коментаря будь-якою мовою.

О, є один виняток - це діалект SQL, який я зазвичай використовую, який використовує '{comments}'. Іноді я напишу:

CREATE UNIQUE INDEX u1_table ON Table(...);
CREATE {DUPS} INDEX d1_table ON Table(...);

Але навіть це розтяжка.