Zpráva o použití - Usage message

Tento článek má několik problémů. Prosím pomozte vylepši to nebo diskutovat o těchto otázkách na internetu diskusní stránka. (Zjistěte, jak a kdy tyto zprávy ze šablony odebrat) tento článek možná matoucí nebo nejasné čtenářům. Prosím, pomoz nám objasnit článek. Možná o tom bude diskuse diskusní stránka. (Dubna 2008) (Zjistěte, jak a kdy odstranit tuto zprávu šablony) tento článek vyžaduje pozornost odborníka na toto téma. Přidejte prosím důvod nebo a mluvit parametr k této šabloně pro vysvětlení problému s článkem. Při umisťování této značky zvažte přidružení této žádosti s WikiProject. (Dubna 2008) (Zjistěte, jak a kdy odstranit tuto zprávu šablony)

v programování, a zpráva o použití nebo pomocná zpráva odkazuje na krátkou zprávu zobrazenou programem, který využívá a rozhraní příkazového řádku k provedení. Tato zpráva se obvykle skládá ze správného použití příkazového řádku pro program a obsahuje seznam správných argumenty příkazového řádku nebo možnosti přijatelné pro uvedený program.

Zprávy o použití se používají jako rychlý způsob, jak program informuje uživatele o správném příkazu syntax, a neměly by být nahrazeny správnými chybovými zprávami nebo podrobnou dokumentací, například a manuálová stránka.

Vzor

Na platformách podobných Unixu se zprávy o používání obvykle řídí stejným společným vzorem:

• Často začínají příkazem „Usage:“, následovaným seznamem argumenty.
• Chcete-li označit volitelné argumenty, Hranaté závorky se běžně používají a lze je také použít ke seskupení parametrů, které je třeba zadat společně.
• Chcete-li označit požadované argumenty, Úhlové závorky se běžně používají podle stejných konvencí seskupování jako hranaté závorky.
• Exkluzivní parametry lze označit oddělením pomocí svislé pruhy ve skupinách.

Příklady

Zde je příklad založený na NetBSD průvodce stylem zdrojového kódu:

Použití: program [-aDde] [-f | -g] [-n číslo] [-b b_arg | -c c_arg] req1 req2 [opt1 [opt2]]

To by znamenalo, že „program“ by měl být volán pomocí:

• volby bez operandů: a, D, d, e (kterékoli z nich lze vynechat). V tomto případě se v některých parametrech rozlišují velká a malá písmena
• exkluzivní možnosti: f, g (označeno svislou čarou)
• možnosti s operandy: n
• exkluzivní možnosti s operandy: b, c
• požadované argumenty: req1, req2
• volitelný argument opt1, který lze použít s nebo bez opt2 (označený jako volitelný ve skupině pomocí jiné sady hranatých závorek)
• volitelný argument opt2, který vyžaduje opt1

Implementace

Chcete-li vytisknout prohlášení o použití v a shell skript, dalo by se napsat:

případ "$ arg" za ... h) printf 'Použití:% s parametr1 parametr2 ...  n' "$(basename "$0")"   výstup 0   ;;...esac

Anti-vzory

Prohlášení o použití není chybová zpráva, ale často se používá jako líný způsob, jak se vyhnout tisku užitečné chybové zprávy. Správně napsaný program příkazového řádku vytiskne stručnou chybovou zprávu, která popisuje přesnou chybu volajícího, nikoli tisk prohlášení o použití a požadavek, aby uživatel zjistil, o jakou chybu se jedná. Pokud se uživateli nepodaří předat správný počet argumentů, například jeden řádek uvádějící, že chybí argument, je mnohem užitečnější než několik stránek výstupu poskytujících obecné použití. Jako důsledek by prohlášení o použití mělo být vytištěno, pouze pokud to uživatel výslovně požaduje (via --help, nebo -h, nebo -?, Nebo nějaký podobný příznak nebo argument) a mělo by být zapsáno do stdout^{[Citace je zapotřebí ]}.

Viz také

• Analýza argumentů příkazového řádku