mensaje de uso


En la programación de computadoras , un mensaje de uso o mensaje de ayuda se refiere a un breve mensaje que muestra un programa que utiliza una interfaz de línea de comandos para su ejecución. Este mensaje generalmente consiste en el uso correcto de la línea de comandos para el programa e incluye una lista de los argumentos u opciones correctos de la línea de comandos aceptables para dicho programa.

Los mensajes de uso se utilizan como una forma rápida para que un programa informe al usuario sobre la sintaxis de comandos adecuada y no deben sustituirse por mensajes de error adecuados o por documentación detallada, como una página de manual .

Una declaración de uso no es un mensaje de error, pero a menudo se usa como una forma perezosa de evitar imprimir un mensaje de error útil. Una declaración de uso solo debe imprimirse cuando el usuario lo solicite específicamente (a través de ayuda, o -h, o -?, o algún indicador o argumento similar) y debe escribirse en la salida estándar; [1] [2] si el usuario ingresó una línea de comando incorrecta, un programa de línea de comando correctamente escrito imprimirá un mensaje de error sucinto que describe el error exacto cometido por el usuario en lugar de imprimir la declaración de uso y requerir que el usuario averigüe cual fue el error. Si el usuario no pasa el número correcto de argumentos, por ejemplo, una sola línea que indique que falta un argumento es mucho más útil que varias páginas de resultados que proporcionen un uso general.