Foydalanish haqidagi xabar - Usage message
 | Ushbu maqolada bir nechta muammolar mavjud. Iltimos yordam bering uni yaxshilang yoki ushbu masalalarni muhokama qiling munozara sahifasi. (Ushbu shablon xabarlarini qanday va qachon olib tashlashni bilib oling) (Ushbu shablon xabarini qanday va qachon olib tashlashni bilib oling)
|
Yilda kompyuter dasturlash, a foydalanish to'g'risidagi xabar yoki yordam xabari dan foydalanadigan dastur ko'rsatadigan qisqacha xabarga ishora qiladi buyruq qatori interfeysi ijro uchun. Ushbu xabar odatda dastur uchun to'g'ri buyruq satrini ishlatishdan iborat va to'g'ri ro'yxatini o'z ichiga oladi buyruq qatoridagi argumentlar yoki imkoniyatlari ushbu dastur uchun maqbul.
Foydalanish to'g'risidagi xabarlar dastur uchun foydalanuvchiga to'g'ri buyruq haqida ma'lumot berishning tezkor usuli sifatida ishlatiladi sintaksis, va tegishli xato xabarlari bilan almashtirilmasligi kerak yoki masalan man sahifasi.
Naqsh
Unix-ga o'xshash platformalarda foydalanish to'g'risidagi xabarlar odatda bir xil odatiy naqshga amal qiladi:
- Ular ko'pincha "Usage:" buyrug'i bilan boshlanadi, so'ngra ro'yxati dalillar.
- Ixtiyoriy dalillarni ko'rsatish uchun, Kvadrat qavslar odatda ishlatiladi va birgalikda ko'rsatilishi kerak bo'lgan parametrlarni guruhlash uchun ham foydalanish mumkin.
- Kerakli dalillarni ko'rsatish uchun, Burchakli qavslar kvadrat qavslar bilan bir xil guruhlash konventsiyalariga rioya qilgan holda, odatda ishlatiladi.
- Eksklyuziv parametrlarni ularni ajratish orqali ko'rsatish mumkin vertikal chiziqlar guruhlar ichida.
Misollar
Ga asoslangan bir misol NetBSD manba kodi uslubi bo'yicha qo'llanma:
Foydalanish: dastur [-aDde] [-f | -g] [-n son] [-b b_arg | -c c_arg] req1 req2 [opt1 [opt2]]Bu "dastur" ni quyidagilar bilan chaqirish kerakligini bildiradi.
- operandasiz variantlar: a, D, d, e (ulardan birortasi qoldirilishi mumkin). Bunday holda ba'zi parametrlar katta-kichikligiga e'tibor berishini unutmang
- eksklyuziv variantlar: f, g (vertikal chiziq bilan belgilanadi)
- operandlar bilan variantlar: n
- operandalar bilan eksklyuziv variantlar: b, c
- talab qilinadigan argumentlar: req1, req2
- opt2 bilan yoki bo'lmagan holda ishlatilishi mumkin bo'lgan opt1 argumenti (boshqa kvadrat qavslar to'plami yordamida guruh ichida ixtiyoriy ravishda belgilangan)
- opt1 talab qiladigan opt2 argumenti
Amalga oshirish
A-da foydalanish bayonotini chop etish uchun shell skript, yozishi mumkin:
ish "$ arg" ... soat ichida) printf 'Foydalanish:% s parametri1 parametri2 ... n' "$(asosiy ism "$0")" Chiqish 0 ;;...esacAnti-naqshlar
Foydalanish to'g'risidagi bayonot xato xabari emas, lekin ko'pincha foydali xato xabarini bosib chiqarmaslik uchun dangasa usul sifatida ishlatiladi. To'g'ri yozilgan buyruq satri dasturi foydalanuvchi bayonotini chop etish o'rniga foydalanuvchi tomonidan xato aniqlanganligini aniqlab berishni talab qilgandan ko'ra, qo'ng'iroq qiluvchining aniq xatosini tavsiflovchi qisqacha xato xabarini chop etadi. Agar foydalanuvchi kerakli miqdordagi argumentlarni ololmasa, masalan, argument etishmayotganligini ko'rsatuvchi bitta satr umumiy foydalanishni ta'minlaydigan bir necha sahifali chiqimlarga qaraganda ancha foydalidir. Xulosa sifatida foydalanish to'g'risidagi bayonot faqat foydalanuvchi tomonidan maxsus so'ralganda (--help, yoki -h, yoki -?, Yoki shunga o'xshash bayroq yoki dalillar orqali) bosilib chiqarilishi va stdout-ga yozilishi kerak.[iqtibos kerak ].