Cách để tạo ra các bình luận đa dòng trong Bash?

Gần đây tôi đã bắt đầu nghiên cứu kịch bản shell và tôi muốn có thể nhận xét một tập hợp các dòng trong một kịch bản shell. Ý tôi là giống như trong trường hợp của C / Java:

/* comment1
   comment2 
   comment3
*/`

Làm thế nào tôi có thể làm điều đó?

Sử dụng : 'để mở và 'đóng.

Ví dụ:

: '
This is a
very neat comment
in bash
'

Bình luận đa dòng trong bash

: <<'END_COMMENT'
This is a heredoc (<<) redirected to a NOP command (:).
The single quotes around END_COMMENT are important,
because it disables variable resolving and command resolving
within these lines.  Without the single-quotes around END_COMMENT,
the following two $() `` commands would get executed:
$(gibberish command)
`rm -fr mydir`
comment1
comment2 
comment3
END_COMMENT

Tôi đang cập nhật bài đăng này dựa trên các bình luận và câu trả lời khác, vì vậy các bình luận trước ngày 22 tháng 5 năm 2020 có thể không còn được áp dụng.

Bash không cung cấp cú pháp dựng sẵn cho nhận xét nhiều dòng nhưng có những bản hack sử dụng cú pháp bash hiện có "xảy ra để làm việc ngay bây giờ".

Cá nhân tôi nghĩ đơn giản nhất (nghĩa là ít ồn ào nhất, kỳ lạ nhất, dễ gõ nhất, rõ ràng nhất) là sử dụng HEREDOC được trích dẫn, nhưng hãy làm rõ những gì bạn đang làm và sử dụng cùng một dấu HEREDOC ở mọi nơi:

<<'### BLOCK COMMENT'
line 1
line 2

line 3
line 4
### BLOCK COMMENT

Trích dẫn một lần đánh dấu HEREDOC tránh một số tác dụng phụ phân tích cú pháp vỏ, chẳng hạn như các phần phụ kỳ lạ sẽ gây ra sự cố hoặc đầu ra và thậm chí phân tích cú pháp của chính điểm đánh dấu. Vì vậy, các trích dẫn đơn cho phép bạn tự do hơn trên điểm đánh dấu nhận xét đóng. Ví dụ: phần sau sử dụng hàm băm ba loại gợi ý nhận xét nhiều dòng trong bash. Điều này sẽ sụp đổ kịch bản nếu dấu ngoặc đơn không có. Ngay cả khi bạn xóa ###, FOO{}tập lệnh sẽ bị lỗi (hoặc gây ra sự thay thế xấu được in nếu không set -e) nếu nó không dành cho các dấu ngoặc đơn:

set -e

<<'### BLOCK COMMENT'
something something ${FOO{}} something
more comment
### BLOCK COMMENT

ls

Tất nhiên bạn có thể chỉ cần sử dụng

set -e

<<'###'
something something ${FOO{}} something
more comment
###

ls

nhưng ý định của điều này chắc chắn ít rõ ràng hơn đối với một độc giả không quen thuộc với mánh khóe này.

Ngày nay, bất kỳ trình soạn thảo tốt nào cũng cho phép bạn nhấn ctrl- / hoặc tương tự, để bỏ / bình luận lựa chọn. Mọi người chắc chắn hiểu điều này:

# something something ${FOO{}} something
# more comment
# yet another line of comment

mặc dù phải thừa nhận, điều này gần như không thuận tiện như nhận xét khối ở trên nếu bạn muốn điền lại đoạn văn của mình.

Chắc chắn có những kỹ thuật khác, nhưng dường như không có cách nào "thông thường" để làm điều đó. Sẽ thật tuyệt nếu ###>và ###<có thể được thêm vào bash để chỉ ra bắt đầu và kết thúc khối bình luận, có vẻ như nó có thể khá đơn giản.

Sau khi đọc các câu trả lời khác ở đây, tôi đã đưa ra câu trả lời dưới đây, IMHO làm cho nó thực sự rõ ràng đó là một nhận xét. Đặc biệt thích hợp cho thông tin sử dụng trong tập lệnh:

<< ////

Usage:
This script launches a spaceship to the moon. It's doing so by 
leveraging the power of the Fifth Element, AKA Leeloo.
Will only work if you're Bruce Willis or a relative of Milla Jovovich.

////

Là một lập trình viên, chuỗi các dấu gạch chéo ngay lập tức đăng ký trong não tôi dưới dạng một nhận xét (mặc dù các dấu gạch chéo thường được sử dụng cho các nhận xét dòng).

Tất nhiên, "////"chỉ là một chuỗi; số lượng dấu gạch chéo trong tiền tố và hậu tố phải bằng nhau.

ý kiến ​​của bạn về điều này là gì?

function giveitauniquename()
{
  so this is a comment
  echo "there's no need to further escape apostrophes/etc if you are commenting your code this way"
  the drawback is it will be stored in memory as a function as long as your script runs unless you explicitly unset it
  only valid-ish bash allowed inside for instance these would not work without the "pound" signs:
  1, for #((
  2, this #wouldn't work either
  function giveitadifferentuniquename()
  {
    echo nestable
  }
}

Đây là cách tôi thực hiện bình luận đa dòng trong bash.

Cơ chế này có hai ưu điểm mà tôi đánh giá cao. Một là ý kiến ​​có thể được lồng nhau. Khác là các khối có thể được kích hoạt bằng cách bình luận ra dòng bắt đầu.

#!/bin/bash
# : <<'####.block.A'
echo "foo {" 1>&2
fn data1
echo "foo }" 1>&2
: <<'####.block.B'
fn data2 || exit
exit 1
####.block.B
echo "can't happen" 1>&2
####.block.A

Trong ví dụ trên, khối "B" được nhận xét, nhưng các phần của khối "A" không phải là khối "B" không được nhận xét.

Chạy ví dụ đó sẽ tạo ra kết quả này:

foo {
./example: line 5: fn: command not found
foo }
can't happen

Tôi đã thử câu trả lời đã chọn, nhưng thấy khi tôi chạy tập lệnh shell có nó, toàn bộ điều này đã được in ra màn hình (tương tự như cách máy tính xách tay jupyter in ra mọi thứ trong '''xx'''ngoặc kép) và cuối cùng có thông báo lỗi. Nó không làm gì cả, nhưng: đáng sợ . Sau đó, tôi nhận ra trong khi chỉnh sửa nó rằng dấu ngoặc đơn có thể trải dài trên nhiều dòng. Vì vậy, .. chỉ cần gán khối cho một biến.

x='
echo "these lines will all become comments."
echo "just make sure you don_t use single-quotes!"

ls -l
date

'

Giải pháp đơn giản, không nhiều thông minh:

Tạm thời chặn một phần của tập lệnh:

if false; then
    while you respect syntax a bit, please
    do write here (almost) whatever you want.
    but when you are
    done # write
fi

Một phiên bản tinh vi một chút:

time_of_debug=false # Let's set this variable at the beginning of a script

if $time_of_debug; then # in a middle of the script  
    echo I keep this code aside until there is the time of debug!
fi

# Tôi thích sự lười biếng và đơn giản. Tôi sẽ sử dụng # với một cách giải quyết hài hước:

1 BÁO CHÍ:] tìm ctrl + F hoặc cmd + F hoặc bất cứ điều gì [để kích hoạt chức năng tìm

2 sử dụng biểu thức chính trong trường tìm như: (^.+)

3 thay thế bằng: # $1hoặc nếu bạn thích#$1

# Lưu ý: bạn có thể không có ba bước trong trình chỉnh sửa của mình. Trong trường hợp đó, hãy sử dụng công cụ regex trực tuyến (không thể đề xuất một công cụ ở đây vì lý do chính sách):

1. Chọn, sao chép văn bản mọi lúc mọi nơi và dán nó vào công cụ regex trực tuyến
2. Sử dụng (^.+)như biểu thức chính quy và #$1hoặc #\1thay thế
3. Chọn, sao chép văn bản và dán lại nơi bạn bắt đầu

# Thưởng thức băm của bạn!