Пайдалану туралы хабарлама - Usage message
 | Бұл мақалада бірнеше мәселе бар. Өтінемін көмектесіңіз оны жақсарту немесе осы мәселелерді талқылау талқылау беті. (Бұл шаблон хабарламаларын қалай және қашан жою керектігін біліп алыңыз) (Бұл шаблон хабарламасын қалай және қашан жою керектігін біліп алыңыз)
|
Жылы компьютерлік бағдарламалау, а пайдалану туралы хабарлама немесе анықтама хабары а қолданатын бағдарлама көрсеткен қысқаша хабарламаға жатады командалық интерфейс орындау үшін. Бұл хабарлама, әдетте, бағдарламаның дұрыс командалық жолын қолданудан тұрады және дұрыс тізімін қамтиды командалық жол аргументтері немесе опциялар аталған бағдарламаға қолайлы.
Пайдаланушы хабарламалары бағдарламаның пайдаланушыға дұрыс команданы хабарлаудың жылдам әдісі ретінде қолданылады синтаксис, және дұрыс қате туралы хабарламалармен немесе а. сияқты егжей-тегжейлі құжаттамамен алмастырылмауы керек адам парағы.
Үлгі
Unix тәрізді платформаларда пайдалану туралы хабарламалар әдетте бірдей жалпы үлгі бойынша жүреді:
- Олар көбіне «Пайдалану:» командасынан басталады, содан кейін тізім дәлелдер.
- Қосымша аргументтерді көрсету үшін, Төрт жақшалар әдетте қолданылады, сонымен бірге бірге көрсетілуі керек параметрлерді топтастыру үшін де қолданыла алады.
- Қажетті дәлелдерді көрсету үшін, Бұрышты жақшалар көбінесе квадрат жақшалар сияқты топтау конвенцияларынан кейін қолданылады.
- Эксклюзивті параметрлерді оларды бөлу арқылы көрсетуге болады тік жолақтар топ ішінде.
Мысалдар
Міне негізделген мысал NetBSD бастапқы код стилі бойынша нұсқаулық:
Қолданылуы: бағдарлама [-aDde] [-f | -g] [-n сан] [-b b_arg | -c c_arg] req1 req2 [opt1 [opt2]]Бұл «бағдарламаны» келесі атпен шақыру керектігін көрсетеді.
- операндсыз опциялар: a, D, d, e (кез-келгенін қалдыруға болады). Бұл жағдайда кейбір параметрлер регистрге тәуелді болатындығын ескеріңіз
- эксклюзивті опциялар: f, g (тік жолақпен белгіленеді)
- операндтары бар опциялар: n
- операндтары бар эксклюзивті опциялар: b, c
- қажетті аргументтер: req1, req2
- оптикалық оптиямен немесе онсыз қолданылуы мүмкін оптикалық қосымша аргумент (төртбұрышты жақшалардың басқа жиынтығын қолдану арқылы топ ішінде міндетті емес деп белгіленген)
- оптикалық аргумент, оған опт1 қажет
Іске асыру
Пайдалану мәлімдемесін a-ға басып шығару үшін қабықша сценарийі, жазуы мүмкін:
іс "$ arg" ... сағ) printf 'Қолдану:% s parameter1 parameter2 ... n' "$(негізгі ат "$0")" Шығу 0 ;;...esacАнти-үлгілер
Пайдалану туралы мәлімдеме қате туралы хабарлама емес, бірақ көбінесе пайдалы қате туралы хабарламаны басып шығарудан аулақ болу үшін қолданылады. Дұрыс жазылған командалық жол бағдарлама қате туралы хабарламаны басып шығарады, ол пайдалану операторын басудан гөрі қоңырау шалушының нақты қателігін сипаттайды және пайдаланушыдан қандай қате болғанын анықтайды. Егер пайдаланушы аргументтердің дұрыс санын бере алмаса, мысалы, аргумент жоқ деген жалғыз жол, жалпы пайдалануды қамтамасыз ететін бірнеше парақтан гөрі әлдеқайда пайдалы. Қорытынды ретінде пайдалану туралы мәлімдеме тек пайдаланушы арнайы сұраған кезде басылуы керек (--help, немесе -h, немесе -?, Немесе осыған ұқсас жалауша немесе аргумент арқылы) және stdout-қа жазылуы керек[дәйексөз қажет ].