如何在 Bash 脚本中添加注释 |
在 Bash 脚本中添加注释是保持代码整洁且易于理解的最有效方法之一。 你可能会问为什么。 假设你的脚本包含一个复杂的正则表达式或多个复杂的代码块,在这种情况下,你可以添加注释,以便其他开发人员或你可以了解该代码块的含义。 注释掉部分代码也有助于调试脚本。 在本教程中,我将引导你了解在 Bash 脚本中添加注释的三种方法:
那么让我们从第一个开始。 Bash 中的单行注释 要添加单行注释,你必须将哈希符号( 这是一个简单的例子: #!/bin/bash# This is a commentecho "Hello, World!" 执行时,注释将被忽略,当我执行上面的命令时,它看起来像这样: 注释规则的唯一例外是脚本开头的 #!/bin/bash 行。它称为 释伴,用于指定运行脚本时要使用的解释器。有不同的 Shell,语法也可能不同。因此,一个好的做法是指定脚本是为哪个 Shell 编写的。例如,如果是 ksh,则可以使用 #!/bin/ksh. Bash 脚本中的内联注释 或者,你可以将注释放在代码块内以记录该特定行的用途。 之后的任何内容在该行结束之前都不会执行,因此请确保在代码末尾添加注释。 这是一个简单的例子:
顾名思义,Bash 脚本中的多行注释允许你在多行中编写注释,或者通过将它们放在多行注释部分来阻止执行代码块: 在每行的开头使用 # 冒号表示法(使用冒号后跟单引号) 现场文档(使用 << 后跟分隔符) 那么让我们从第一个开始。 1、对块注释的每一行使用 # 如果你的目的是解释脚本的一部分,我建议使用此方法。毕竟, 这也是许多开发人员使用的方法。 假设你必须在一开始就解释脚本的用途、作者信息或许可信息。你可以这样写: #!/bin/bash ###################################### ## This script is used for scanning ## ## local network ## ## Licensed under GPL 2.0 ## ###################################### 这个 Bash 脚本的其它部分…… 当你想说明 Bash 脚本的行为方式时这不错。如果你正在调试 Bash 脚本并希望隐藏部分脚本,则在所需代码的每一行开头添加 接下来的两节将帮助你做到这一点。 2、冒号表示法 要使用冒号表示法,请在 #!/bin/bash : ' This is how you can use colon notation And this line too will be ignored ' echo "GOODBYE" 当你执行上面的脚本时,它应该只打印 GOODBYE。 3、现场文档 到目前为止,这是在 Bash 中编写多行注释的最流行的方法,你可以使用 (LCTT 译注:在编程领域,“here document” 是一个常见的术语,特指在脚本语言(如 Perl、Bash)中,能够直接在代码内部嵌入并处理一个数据块或文本串的技术。尽管传统上我们将它翻译为“嵌入式文档” 或不翻译,但这个译法似乎并不能完全地体现出原文的感觉和含义。为了让这个概念变得更为直观和易理解,我们建议将 “here document” 翻译为 “现场文档”。“现场”相比于“嵌入式”,更好的传达了文档就在代码的当前位置,或代码“现场”的含义。这样的译法也与原文 “here document” 中 “here”(这里)的含义更为契合。我们希望这个译法能够在未来得到更广泛的使用和认可,让编程的世界因语言的精准而变得更美好。PS., 该译法和解释得到了 ChatGPT 的建议和生成。) 使用方法如下:
还困惑吗? 这是一个简单的例子:
在上面的示例中,我使用了 当我执行上面的脚本时,它给出了以下输出: 正如你所看到的,它忽略了从 我希望本指南对你有所帮助。 |