Сообщение об использовании - Usage message

Эта статья поднимает множество проблем. Пожалуйста помоги Улучши это или обсудите эти вопросы на страница обсуждения. (Узнайте, как и когда удалить эти сообщения-шаблоны) Эта статья может быть сбивает с толку или неясно читателям. Пожалуйста, помоги нам прояснить статью. Возможно обсуждение этого вопроса на страница обсуждения. (Апрель 2008 г.) (Узнайте, как и когда удалить этот шаблон сообщения) Эта статья требует внимания эксперта по предмету. Пожалуйста, добавьте причина или разговаривать в этот шаблон, чтобы объяснить проблему со статьей. При размещении этого тега учитывайте связывая этот запрос с ВикиПроект. (Апрель 2008 г.) (Узнайте, как и когда удалить этот шаблон сообщения)

В компьютерное программирование, а сообщение об использовании или же справочное сообщение относится к краткому сообщению, отображаемому программой, использующей Интерфейс командной строки для исполнения. Это сообщение обычно состоит из правильного использования командной строки для программы и включает список правильных аргументы командной строки или же опции приемлемо для указанной программы.

Сообщения об использовании используются как быстрый способ для программы сообщить пользователю правильную команду. синтаксис, и не должны заменять правильные сообщения об ошибках или подробную документацию, такую ​​как страница руководства.

Шаблон

На 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
• необязательный аргумент opt1, который может использоваться с opt2 или без него (помечен как необязательный внутри группы с помощью другого набора квадратных скобок)
• необязательный аргумент opt2, который требует opt1

Выполнение

Чтобы распечатать заявление об использовании в сценарий оболочки можно было бы написать:

дело "$ arg" в ... ч) printf 'Использование:% s параметр1 параметр2 ...  n' "$(базовое имя "$0")"   выход 0   ;;...esac

Антипаттерны

Заявление об использовании не является сообщением об ошибке, но часто используется как ленивый способ избежать вывода полезного сообщения об ошибке. Правильно написанная программа командной строки напечатает краткое сообщение об ошибке, которое описывает точную ошибку, допущенную вызывающей стороной, вместо того, чтобы печатать заявление об использовании и требовать от пользователя выяснить, в чем была ошибка. Если пользователь не может передать правильное количество аргументов, например, одна строка, в которой указывается, что аргумент отсутствует, гораздо полезнее, чем несколько страниц вывода, обеспечивающих общее использование. Как следствие, оператор использования должен печататься только по специальному запросу пользователя (через --help, или -h, или -? Или какой-либо аналогичный флаг или аргумент) и должен быть записан в stdout^{[нужна цитата ]}.

Смотрите также

• Анализ аргументов командной строки