ConvertTo-BlockComment¶
SYNOPSIS¶
Converts a given text string into a block comment
SYNTAX¶
ConvertTo-BlockComment [-InputObject] <String[]> [[-CommentCharacter] <String>]
[<CommonParameters>]
DESCRIPTION¶
Converts a given text string into a block comment by prepending a given character to the start of each string
EXAMPLES¶
Example 1¶
Would result in "# My String" being returned.
PARAMETERS¶
-CommentCharacter¶
The character to prepend to each string
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: "#"
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-InputObject¶
The string(s) to be turned into a block comment
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.