blocks|key|344608|text|我更愿意这样写：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|344609|Usage:+`basename+$0`+[option1]%7C[option2]+param1
++Options:
+++-+option1:++.....
+++-+option2:++.....
++Parameters:
+++-+param1:+++.....+|code-block|syntax|javascript|344610|尝试查看标准UNIX实用程序的帮助格式(例如ls+--help+)|344611|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|K|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|L|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|M|8|@]|9|@]|A|$]]|$1|I|3|-4|5|6|7|N|8|@]|9|@]|A|$]]]|J|$]]

I would rather write:

<pre><code>Usage: `basename $0` [option1]|[option2] param1
 Options:
 - option1: .....
 - option2: .....
 Parameters:
 - param1: ..... 
</code></pre>

Try to look at the way help is formatted for standard UNIX utilities (ls --help, for instance)

blocks|key|344613|text|我建议让你的脚本自动打印用法(如果它不应该在没有参数的情况下运行)：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|344614|#!/usr/bin/env+bash

if+[+$#+==+0+];+then
++++echo+"Usage:+$0+param1+[param2]"
++++echo+"*+param1:+<description>"
++++echo+"*+param2:+<description>"
fi|code-block|syntax|javascript|344615|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

I would recommend making your script automatically print usage (if it shouldn't be run without arguments):

<pre><code>#!/usr/bin/env bash

if [ $# == 0 ]; then
 echo "Usage: $0 param1 [param2]"
 echo "* param1: &lt;description&gt;"
 echo "* param2: &lt;description&gt;"
fi
</code></pre>

blocks|key|344617|text|执行此操作的Vim+bash+IDE：|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|344618|#!/bin/bash
#===============================================================================
#
#++++++++++FILE:++test.sh
#
#+++++++++USAGE:++./test.sh
#
#+++DESCRIPTION:
#
#+++++++OPTIONS:++---
#++REQUIREMENTS:++---
#++++++++++BUGS:++---
#+++++++++NOTES:++---
#++++++++AUTHOR:++Joe+Brockmeier,+jzb@zonker.net
#+++++++COMPANY:++Dissociated+Press
#+++++++VERSION:++1.0
#+++++++CREATED:++05/25/2007+10:31:01+PM+MDT
#++++++REVISION:++---
#===============================================================================|code-block|syntax|javascript|344619|entityMap|0|LINK|mutability|MUTABLE|url|http://www.linux.com/feature/114359^0|6|C|0|0|0^^$0|@$1|2|3|4|5|6|7|Q|8|@]|9|@$A|R|B|S|1|T]]|C|$]]|$1|D|3|E|5|F|7|U|8|@]|9|@]|C|$G|H]]|$1|I|3|-4|5|6|7|V|8|@]|9|@]|C|$]]]|J|$K|$5|L|M|N|C|$O|P]]]]

The <a href="http://www.linux.com/feature/114359" rel="noreferrer">Vim bash IDE</a> that does this:

<pre><code>#!/bin/bash
#===============================================================================
#
# FILE: test.sh
#
# USAGE: ./test.sh
#
# DESCRIPTION:
#
# OPTIONS: ---
# REQUIREMENTS: ---
# BUGS: ---
# NOTES: ---
# AUTHOR: Joe Brockmeier, jzb@zonker.net
# COMPANY: Dissociated Press
# VERSION: 1.0
# CREATED: 05/25/2007 10:31:01 PM MDT
# REVISION: ---
#===============================================================================
</code></pre>

blocks|key|3121944|text|我通常将我的用法包装在函数中，这样我就可以从-h参数等调用它。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|3121945|#!/bin/bash
usage()+{
++++cat+<<EOM
++++Usage:
++++$(basename+$0)+Explain+options+here

EOM
++++exit+0
}

[+-z+$1+]+&&+{+usage;+}|code-block|syntax|javascript|3121946|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

I usually wrap my usage in function so I can call it from a -h param etc.

<pre><code>#!/bin/bash
usage() {
 cat &lt;&lt;EOM
 Usage:
 $(basename $0) Explain options here

EOM
 exit 0
}

[ -z $1 ] &amp;&amp; { usage; }
</code></pre>

blocks|key|346008|text|传统上，您需要在the+()函数中记录参数：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|346009|#!/bin/bash

programname=$0

function+usage+{
++++echo+"usage:+$programname+[-abch]+[-f+infile]+[-o+outfile]"
++++echo+"++-a++++++turn+on+feature+a"
++++echo+"++-b++++++turn+on+feature+b"
++++echo+"++-c++++++turn+on+feature+c"
++++echo+"++-h++++++display+help"
++++echo+"++-f+infile+++specify+input+file+infile"
++++echo+"++-o+outfile++specify+output+file+outfile"
++++exit+1
}

usage|code-block|syntax|javascript|346010|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

Traditionally you document your arguments in the usage() function:

<pre><code>#!/bin/bash

programname=$0

function usage {
 echo "usage: $programname [-abch] [-f infile] [-o outfile]"
 echo " -a turn on feature a"
 echo " -b turn on feature b"
 echo " -c turn on feature c"
 echo " -h display help"
 echo " -f infile specify input file infile"
 echo " -o outfile specify output file outfile"
 exit 1
}

usage
</code></pre>

blocks|key|3121973|text|我会使用heredoc重新评论：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|3121974|usage+()+{
++++cat+<<HELP_USAGE

++++$0++[-a]+-f+<file>

+++-a++All+the+instances.
+++-f++File+to+write+all+the+log+lines
HELP_USAGE
}|code-block|syntax|javascript|3121975|而不是：|3121976|echo+"$0++[-a]+-f+<file>"
echo
echo+"-a++All+the+instances."
echo+"-f++File+to+write+all+the+log+lines."|3121977|我认为它比所有这些回音线都干净得多。|3121978|entityMap^0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|O|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|P|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|Q|8|@]|9|@]|A|$]]|$1|I|3|J|5|D|7|R|8|@]|9|@]|A|$E|F]]|$1|K|3|L|5|6|7|S|8|@]|9|@]|A|$]]|$1|M|3|-4|5|6|7|T|8|@]|9|@]|A|$]]]|N|$]]

I would recomment using a heredoc:

<pre><code>usage () {
 cat &lt;&lt;HELP_USAGE

 $0 [-a] -f &lt;file&gt;

 -a All the instances.
 -f File to write all the log lines
HELP_USAGE
}
</code></pre>

instead of:

<pre><code>echo "$0 [-a] -f &lt;file&gt;"
echo
echo "-a All the instances."
echo "-f File to write all the log lines."
</code></pre>

I think it is way cleaner than all these echo lines.

Is there a convention for documenting shell scripts' parameters?

For example:

<pre><code>#!/usr/bin/env bash

# &lt;description&gt;
#
# Usage:
# $ ./myScript param1 [param2]
# * param1: &lt;description&gt;
# * param2: &lt;description&gt;
</code></pre>

A few things I don't like about this particular template:

<ul>
<li>the script's file name (<code>myScript</code>) appears within the file itself</li>
<li>parameter description seems weird</li>
<li>the leading space before <code>$</code> is visually useful, but can lead to confusion in languages with block comments, causing some validation tools to complain about mixed/inconsisent indentation (e.g. spaces in this block, tabs for code - provided one prefers tabs, of course)</li>
</ul>

Are there any guidelines on this?

documenting shell scripts' parameters

是否有记录shell脚本参数的约定？例如：#!/usr/bin/env bash# <description>## Usage:# $ ./myScript param1 [param2]# * param1: <description># * param2: <description>关于这个特定的模板，有一些我不...

问记录shell脚本的参数
EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问记录shell脚本的参数EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问记录shell脚本的参数
EN