Zero's Blog

脚本描述头信息

| | Visitors |

添加脚本描述头信息

当编写脚本或者其他程序是，在脚本开头添加脚本描述信息，更方便的向阅读脚本的人来解释脚本用途并提供他们需要了解的其他信息

1
2
3
4
5
6
7
8
9
#!/bin/bash
######################################################
## Description: CentOS5.4 Initialization Script     ##
## Version: 1.0                                     ##
## Date: 2015-09-01                                 ##
## Author: Charlie.Cui                              ##
## Mail: Charlie.cui127@gmail.com                   ##  
## License: General Public License (GPL)            ##
######################################################

通过脚本生成脚本描述头

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
#!/bin/bash
if ! grep "^#!" $1 &>/dev/null
then
cat >> $1 << EOF
#!/bin/bash
####################################################
## Title: $1                                        
## Description: Please Write Scripts Describing
## Version: 1.0                                     
## Date: `date +%F`                                 
## Author: Charlie.Cui                              
## Mail: Charlie.cui127@gmail.com                     
## License: General Public License (GPL)            
####################################################
EOF
fi
vim +4 $1

增加执行权限，然后通过./makescripts scriptsname.sh生成脚本。