Viết bình luận trong kịch bản bash

Khi viết các tập lệnh Bash, luôn luôn là một cách thực hành tốt để làm cho mã của bạn sạch sẽ và dễ hiểu. Tổ chức mã của bạn theo khối, thụt lề, đưa ra các biến và hàm mô tả tên là một số cách để làm điều này.

Một cách khác để cải thiện khả năng đọc mã của bạn là sử dụng các bình luận. Một bình luận là một lời giải thích hoặc chú thích có thể đọc được của con người được viết bằng kịch bản shell.

Thêm nhận xét vào tập lệnh Bash của bạn sẽ giúp bạn tiết kiệm rất nhiều thời gian và công sức khi bạn xem mã của mình trong tương lai. Giả sử bạn muốn thay đổi một tập lệnh mà bạn đã viết vài tháng hoặc vài năm trước. Có thể bạn sẽ không nhớ tại sao bạn lại viết một số đoạn mã phức tạp trừ khi bạn thêm một bình luận.

Các ý kiến ​​cũng giúp các nhà phát triển và quản trị viên hệ thống khác, những người có thể cần duy trì tập lệnh để hiểu mã của bạn và mục đích của nó.

Nhận xét thường được sử dụng để giải thích những gì mã không thể. Ví dụ, nếu bạn có một biểu thức chính quy hoặc thay thế tham số phức tạp bên trong tập lệnh Bash của bạn, bạn nên viết một nhận xét về những gì mã làm. Bình luận nên ngắn gọn và đi vào vấn đề Không giải thích một cái gì đó đơn giản và rõ ràng cho người đọc.

, chúng tôi sẽ đề cập đến những điều cơ bản của việc viết bình luận trong Bash.

Viết bình luận bằng Bash

Bash bỏ qua mọi thứ được viết sau dấu băm ( # ) trên dòng. Ngoại lệ duy nhất cho quy tắc này là khi dòng đầu tiên trên tập lệnh bắt đầu bằng #! nhân vật. Chuỗi ký tự này được gọi là Shebang và được sử dụng để báo cho hệ điều hành sử dụng trình thông dịch để phân tích phần còn lại của tệp.

Nhận xét có thể được thêm vào lúc bắt đầu trên dòng hoặc nội tuyến với mã khác:

# This is a Bash comment. echo "This is Code" # This is an inline Bash comment.

Không gian trống sau dấu băm là không bắt buộc, nhưng nó sẽ cải thiện khả năng đọc của bình luận.

Thông thường, khi tập lệnh được mở trong trình soạn thảo văn bản, các bình luận được thể hiện bằng màu xanh lá cây.

Nhận xét cũng hữu ích khi kiểm tra một kịch bản. Thay vì xóa một số dòng hoặc khối, bạn có thể nhận xét chúng:

# if]; then # echo "Variable is greater than 10." # fi

Nhận xét đa dòng trong Bash

Không giống như hầu hết các ngôn ngữ lập trình, Bash không hỗ trợ các bình luận đa dòng.

Cách đơn giản nhất để viết bình luận đa dòng trong Bash là thêm từng bình luận khác nhau:

# This is the first line. # This is the second line.

Một tùy chọn khác là sử dụng HereDoc. Đây là một loại chuyển hướng cho phép bạn chuyển nhiều dòng đầu vào cho một lệnh. Nếu khối HereDoc không được chuyển hướng đến một lệnh, nó có thể đóng vai trò giữ chỗ bình luận đa dòng:

<< 'MULTILINE-COMMENT' Everything inside the HereDoc body is a multiline comment MULTILINE-COMMENT

Sử dụng HereDoc là một bản hack, không phải là một cách dựng sẵn thực sự để viết các bình luận Bash đa cấp. Để tránh mọi vấn đề, bạn nên sử dụng nhận xét một dòng.

Phần kết luận

Viết bình luận là một thực tiễn tốt và giúp các nhà phát triển khác, bao gồm cả bản thân trong tương lai, hiểu được kịch bản shell. Trong Bash, mọi thứ sau dấu băm ( # ) và cho đến cuối dòng được coi là một nhận xét.

Nếu bạn có bất kỳ câu hỏi hoặc phản hồi, hãy để lại nhận xét.

thiết bị đầu cuối bash