shell多行注释（HERE DOCUMENT）（＜＜‘COMMENT‘）（shell注释shell）（脚本注释）

转载已于 2024-10-14 16:09:18 修改 · 1.3k 阅读

2 ·

CC 4.0 BY-SA版权

原文链接：https://blog.csdn.net/qq_19446965/article/details/106610940

文章标签：

#linux #运维 #服务器

于 2023-04-04 22:17:26 首次发布

shell 专栏收录该内容

70 篇文章

订阅专栏

文章介绍了在Shell脚本中进行多行注释的三种方法：1)使用HEREDOCUMENT特性，如`<<COMMENT`；2)利用`:`命令，需要注意空格；3)采用`:<<COMMENT`方式。每种方法都有其适用场景和注意事项，例如防止字符扩展和命令替换。

文章目录

在写 shell 脚本的时候，经常需要注释多行命令，但在每一行前输入 # ，很不方便。

1、DOCUMENT

可以采用 HERE DOCUMENT 特性，实现多行注释，这是比较稳妥的作法

比如：

#!/bin/bash
<<'COMMENT'
your comment 1
your comment 2
...
 
COMMENT

示例

提示不规范，不知道为啥，我直接用第三种方法

在这里插入图片描述

2、直接采用 `: '`

直接采用 : '这个命令的特殊作用，但这种做法有很多局限性，而且会影响性能。

注意: + 空格 + 单引号。

如下是最简单的使用方法:

#!/bin/bash
: '    # 注意中间有空格
your comment 1
your comment 2
...
'

3、`: + << 'COMMENT'`（暂时用这个）

: <<'COMMENT'
COMMENT

第三种方法，即：采用 : + << 'COMMENT' 的方式。

#!/bin/bash
: <<'COMMENT'
your comment 1
your comment 2
...
COMMENT

示例

#!/bin/bash

: <<'COMMENT'
# 判断部署目录是否已存在
if [ -d "$INSTALL_PATH/$DEPLOY_DIR" ]; then
    # 判断目录是否为空
    if [ "$(ls -A "$INSTALL_PATH/$DEPLOY_DIR")" ]; then
        # 如果目录存在且不为空，则输出提示信息并退出
        echo "目录 $INSTALL_PATH/$DEPLOY_DIR 不为空，无法继续操作"
        exit 1
    fi
fi
COMMENT

注意：要加上单引号部分，有时候虽然不加不会有什么问题，但还是要加，以防出现莫名其妙的意外发生，比如发生字符扩展，命令替换等。

参考文章：shell 多行注释