Question

When I add the following documentation to a PowerShell function:

.PARAMETER Test
The test parameter is nice
and it looks pretty cool.

I get this help when I use the Get-Help FunctionName -Parameter Test command:

-Test <Object>
    The test parameter is nice
    and it looks pretty cool.

I want it to be:

-Test <Object>
    The test parameter is nice and it looks pretty cool.

How can I avoid the line break?

I want the line breaks in my source code because long lines are hard to read. The sample has a short paragraph but my real inline documentation does have long paragraphs.

Answer 1

I don’t see any other option than writing it in one line. If you have long lines try to break them after 80 characters or so.