New-UsageInfo
Crea un objeto de PowerShell que representa una definición de uso de Crescendo.
Syntax
New-UsageInfo
[-usage] <String>
[<CommonParameters>]
Description
Crea un objeto de PowerShell que representa una definición de uso de Crescendo. Puede asignar valores a las propiedades del objeto . El objeto resultante se puede agregar a la propiedad Usage de un objeto de comando o se puede convertir en JSON que se va a insertar en el archivo de configuración. La synopsis del objeto se inserta en el módulo como ayuda basada en comentarios en la .SYNOPSIS
palabra clave .
Ejemplos
Ejemplo 1: Creación de un objeto Usage y conversión a JSON
$usage = New-UsageInfo -usage 'This is a description for how to use the cmdlet.'
$usage | ConvertTo-Json
{
"Synopsis": "This is a description for how to use the cmdlet.",
"SupportsFlags": false,
"HasOptions": false,
"OriginalText": null
}
Parámetros
-usage
Texto que describe el propósito del cmdlet.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Entradas
None
Salidas
Vínculos relacionados
Colaborar con nosotros en GitHub
El origen de este contenido se puede encontrar en GitHub, donde también puede crear y revisar problemas y solicitudes de incorporación de cambios. Para más información, consulte nuestra guía para colaboradores.