tham số của tài liệu shell script '

Question

Có quy ước cho việc ghi lại các tham số của tập lệnh shell không?

Ví dụ:

#!/usr/bin/env bash 

# <description> 
# 
# Usage: 
# $ ./myScript param1 [param2] 
# * param1: <description> 
# * param2: <description> 

Một vài điều tôi không thích về mẫu cụ thể này:

• tên file của kịch bản (myScript) xuất hiện trong tập tin tự mô tả
• tham số có vẻ lạ
• không gian hàng đầu trước $ hữu ích trực quan nhưng có thể dẫn đến nhầm lẫn bằng ngôn ngữ với nhận xét chặn, khiến một số công cụ xác thực khiếu nại về sự thụt lề hỗn hợp/không nhất quán (ví dụ: các khoảng trống trong khối này, các tab cho mã - miễn là một tab thích các tab, tất nhiên)

Có bất kỳ hướng dẫn nào về điều này không?

Answer 1

Tôi thà viết:

Usage: `basename $0` [option1]|[option2] param1 
    Options: 
    - option1: ..... 
    - option2: ..... 
    Parameters: 
    - param1: ..... 

Cố gắng nhìn vào cách giúp đỡ được định dạng cho các tiện ích UNIX chuẩn (ls --help, ví dụ)

Answer 2

Tôi muốn giới thiệu làm cho kịch bản của bạn sẽ tự động in sử dụng (nếu nó không nên chạy mà không có đối số):

#!/usr/bin/env bash 

if [ ${#@} == 0 ]; then 
    echo "Usage: $0 param1 [param2]" 
    echo "* param1: <description>" 
    echo "* param2: <description>" 
fi 

Answer 3

Các Vim bash IDE mà thực hiện điều này:

#!/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: --- 
#=============================================================================== 

Answer 4

Tôi thường quấn sử dụng của tôi trong chức năng vì vậy tôi có thể gọi nó từ một -h param, vv

#!/bin/bash 
usage() { 
    cat <<EOM 
    Usage: 
    $(basename $0) Explain options here 

EOM 
    exit 0 
} 

[ -z $1 ] && { usage; } 

Answer 5

Thông thường bạn đối tài liệu của bạn trong việc sử dụng() chức năng:

#!/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 

Answer 6

Tôi sẽ recomment bằng cách sử dụng một heredoc:

usage() { 
    cat <<HELP_USAGE 

    $0 [-a] -f <file> 

    -a All the instances. 
    -f File to write all the log lines 
HELP_USAGE 
} 

thay vì:

echo "$0 [-a] -f <file>" 
echo 
echo "-a All the instances." 
echo "-f File to write all the log lines." 

Tôi nghĩ nó sạch hơn tất cả các dòng echo.