【BASH】让你的脚本文档化

 

问题：

介绍shell脚本或变量之前，先说下怎样使得你的脚本文档化。很明显，你可能需要几个月之后还能读懂你自己写的脚本。

 

解决方案：

通过注释使得你的脚本文档化。'#'标识了一个注释的，该行'#'后所有的内容将被shell忽略。

#

# This is a comment.

#

# Use comments frequently.

# Comments are your friends.

 

讨论：

有些人写脚本的时候只写了shell语法,正则表达式，或其他仅同语法相关的内容，这就意味着以后将会非常难于理解。

添加注释的时候要注意，不要让你的脚本全部都是注释。最好是在比较奇怪的语句前面添加。

# replace the semi with a blank

NEWPATH=${PATH/;/ }

#

# switch the text on either side of a semi

sed -e 's/^/(.*/);/(.*/)$//2;/1/' < $FILE

甚至是在命令行交互时也可以输入注释，这个可以关掉，但是默认是打开的。很少的情况需要在交互的方式下输入注释。