Shell脚本注释的实现

更新时间：2023年03月23日 09:43:51 作者：liaowenxiong

本文主要介绍了Shell脚本注释的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

单行注释

直接在行最前端加上符号 # 即可。具体用法如下所示：

# this is comment test
echo "this is comment test"

多行注释/段注释

一、空命令 : 和追加输入重定向 <<

:<<BLOCK

....注释内容

BLOCK

说明：

把输入重定义（<<）到前面的命令，但是 : 是空命令，所以就相当于注释了。
这种方法当注释代码里出现变量引用或者是反引号的命令时,shell 会去尝试解析，会提示错误信息，反引号部分不会被注释掉。

例如：

var=`ls -l` # 这个就不会被注释掉，因为有反引号

BLOCK 为 Here Documents 中的定义符号，名称任意，只要前后匹配就行，如下两个例子中分别使用 WORD 和 _a_ 也可以：

例（1）：

:<<WORD

....注释内容

WORD

例（2）：
下面的 :<<_a_ 和 _a_ 代表段注释，可以把中间的代码注释掉，_a_ 为 Here Documents 中的定义符号，名称任意，只要前后匹配就行。

for ((i=0; i<10; i++))
do
:<<_a_    
    if [  ]; then 
        ...
    fi
_a_
    echo ""
done

常用来作为注释的成对字符有：

EOF、_a_、WORD、BLOCK、!

备注：

EOF 截止符用作后续输入命令
! 叹号一般作为嵌入内容部分
' 单引号一般用来区分内容

解决注释中有反引号的问题

方法一

:<<BLOCK'
....注释内容
'BLOCK

方法二

:<<'BLOCK
....注释内容
BLOCK'

方法三

:<<'
....注释内容
'

方法四

:<<\EOF
注释的代码...
EOF

方法五

:<<'EOF'
注释的代码...
EOF

二、空命令 : 和 if…then… 语句

: 就是什么也不做（do nothing）即空命令，一般用在 if…then… 条件中，用作什么也不做的命令，如下：

if [ -d $DIRECTORY ]; then
    :
else
    echo 'the directory do not exit !'
fi

扩展知识：

下面的例（1）是 Here Documents 的用法，意思是将定义符 WORD 传给某脚本或命令。WORD 的内容为两个 WORD 间输入任意内容，这样就可以在脚本中用 cmd 来执行输入而不必再重建一文件。

例（1）：

cmd<<WORD
any input
file content
WORD

Here Documents 常用在菜单屏幕中，看例（2）：
例（2）：

cat <<Menu
1.List
2.Help
3.Exit
Menu

三、空命令 : 和单引号 ’

注意：单引号 ' 和冒号 : 之间要加空格。

# echo is test
echo "test"
echo "test"
echo "test"
echo "test"
echo "test"  
: '
echo "comment"
echo "comment"
echo "comment"
echo "comment"
echo "comment"
echo "comment"
'

到此这篇关于Shell脚本注释的实现的文章就介绍到这了,更多相关Shell脚本注释内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Shell脚本注释写法

linux模糊查找一个文件的方法
这篇文章主要介绍了linux模糊查找一个文件的方法，非常不错，具有一定的参考借鉴价值,需要的朋友可以参考下
2018-06-06
shell 字符串操作(长度，查找，替换)详解
在做shell批处理程序时候，经常会涉及到字符串相关操作。有很多命令语句，如：awk,sed都可以做字符串各种操作。其实shell内置一系列操作符号，可以达到类似效果，大家知道，使用内部操作符会省略启动外部程序等时间，因此速度会非常的快
2012-09-09
Shell脚本实现防止国外ip访问服务器
这篇文章主要介绍了Shell脚本实现防止国外ip访问服务器,本文通过分析使用IP地址库,然后把国外IP指导入iptables并禁止访问实现,需要的朋友可以参考下
2014-12-12
Linux之split命令详解
Linux split命令用于将一个文件分割成数个，该指令将大文件分割成较小的文件，在默认情况下将按照每1000行切割成一个小文件，其基本语法是split [--help][--version][-<行数>][-b <字节>][-C <字节>][-l <行数>][要切割的文件][输出文件名]。
2015-10-10
从apnic提取ip信息脚本分享
这篇文章主要介绍了从apnic提取ip信息的脚本,需要的朋友可以参考下
2014-03-03
Shell中创建序列和数组(list、array）的方法
这篇文章主要介绍了Shell中创建序列和数组(list、array）的方法,本文讲解了seq方法生成以及通过内部{begin..end}生成法,需要的朋友可以参考下
2015-07-07
Linux下使用Shell脚本实现进程监控的流程
这篇文章主要介绍了Linux下使用Shell脚本实现进程监控,在 Linux 平台下，shell 脚本监控是一个非常简单、方便的工具，它可以有效的对服务器、进程进行监控，对系统开发以及进程维护人员非常有帮助，需要的朋友可以参考下
2023-02-02
shell中set -e的具体使用
set -e是一个Shell命令，它用于在脚本运行时自动退出，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-06-06
Linux忘记root密码进入单用户模式切换运行级别切换用户
这篇文章主要介绍了Linux忘记root密码进入单用户模式切换运行级别切换用户,需要的朋友可以参考下
2019-08-08
Linux下使用tcpdump抓包的实现方法
tcpdump是Linux下面的一个开源的抓包工具，和Windows下面的wireshark抓包工具一样，支持抓取指定网口、指定目的地址、指定源地址、指定端口、指定协议的数据。这篇文章主要介绍了Linux下使用tcpdump抓包的实现方法,需要的朋友可以参考下
2015-10-10