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


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

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

Оператор использования не является сообщением об ошибке, но часто используется как ленивый способ избежать вывода полезного сообщения об ошибке. Оператор использования должен выводиться только по специальному запросу пользователя (через --help, или -h, или -?или какой-либо аналогичный флаг или аргумент) и должен записываться в стандартный вывод; [1] [2] если пользователь ввел неверную командную строку, правильно написанная программа командной строки выведет краткое сообщение об ошибке, описывающее точную ошибку, допущенную пользователем, вместо того, чтобы печатать оператор использования и требовать от пользователя выяснить это. в чем была ошибка. Например, если пользователю не удается передать правильное количество аргументов, одна строка, сообщающая об отсутствии аргумента, гораздо полезнее, чем несколько страниц вывода, обеспечивающих общее использование.