Användningsmeddelande
I datorprogrammering hänvisar ett användningsmeddelande eller hjälpmeddelande till ett kort meddelande som visas av ett program som använder ett kommandoradsgränssnitt för exekvering. Detta meddelande består vanligtvis av korrekt kommandoradsanvändning för programmet och inkluderar en lista med korrekta kommandoradsargument eller alternativ som är acceptabla för programmet.
Användningsmeddelanden används som ett snabbt sätt för ett program att informera användaren om korrekt kommandosyntax, och bör inte ersätta korrekta felmeddelanden eller för detaljerad dokumentation såsom en man-sida .
Mönster
På Unix-liknande plattformar följer användningsmeddelanden vanligtvis samma vanliga mönster:
- De börjar ofta med "Usage:" , kommandot, följt av en lista med argument .
- För att indikera valfria argument används vanligen hakparenteser och kan även användas för att gruppera parametrar som måste specificeras tillsammans.
- För att indikera nödvändiga argument används vanligtvis vinklade parenteser , enligt samma grupperingskonventioner som hakparenteser.
- Exklusiva parametrar kan indikeras genom att separera dem med vertikala streck inom grupper.
Exempel
Här är ett exempel baserat på NetBSD källkodstilguiden :
Användning: program [-aDde] [-f | -g] [-n tal] [-b b_arg | -c c_arg] req1 req2 [opt1 [opt2]]Detta skulle indikera att "program" ska anropas med:
- alternativ utan operander: a, D, d, e (vilka som helst kan utelämnas). Observera att i det här fallet är vissa parametrar skiftlägeskänsliga
- exklusiva alternativ: f, g (betecknas med den vertikala stapeln)
- alternativ med operander: n
- exklusiva alternativ med operander: b, c
- nödvändiga argument: req1, req2
- valfritt argument opt1, som kan användas med eller utan opt2 (markerat valfritt inom gruppen genom att använda en annan uppsättning hakparenteser)
- valfritt argument opt2, som kräver opt1
Genomförande
För att skriva ut en användningssats i ett skalskript kan man skriva:
0
case " $arg " i ... h ) printf 'Användning: %s parameter1 parameter2 ...\n' " $( basnamn " $0 " ) " exit ;; ... esac
Antimönster
En användningsförklaring är inte ett felmeddelande, utan används ofta som ett lat sätt att undvika att skriva ut ett användbart felmeddelande. En användningsförklaring bör endast skrivas ut när användaren specifikt begär det (via—hjälp, eller -h, eller -?, eller någon liknande flagga eller argument) och bör skrivas till standardutdata; om användaren har angett en felaktig kommandorad kommer ett korrekt skrivet kommandoradsprogram att skriva ut ett kortfattat felmeddelande som beskriver det exakta felet som användaren gjorde i stället för att skriva ut användningsförklaringen och kräva att användaren ska ta reda på vad felet var. Om användaren misslyckas med att skicka det korrekta antalet argument, till exempel, är en enda rad som anger att ett argument saknas mycket mer användbar än flera utdatasidor som ger en allmän användning.