vscode-powershell icon indicating copy to clipboard operation
vscode-powershell copied to clipboard

Published 20 hours ago • verified publisher icon PowerShell

Feature request: generate help for Input and Output

Open lipkau opened this issue 8 years ago • 4 comments

Description

With the new feature of auto generating the help comments, I would appreciate the following features:

  • generating .INPUT
  • generating .OUTPUT
  • appending [OutputType()]

lipkau avatar May 19 '17 14:05 lipkau

Thanks Oliver!

daviwil avatar May 19 '17 14:05 daviwil

Same as we have function and function-advanced and for the help comments we have help-function and comment-help Can create a help-function-advanced and comment-help-advanced that can include the components @lipkau mentioned or even more

ArieHein avatar Oct 16 '24 11:10 ArieHein

I'm going to flag this as up-for-grabs and will shepherd a PR that adds snippets for function-help and function-advanced-help. These are one of the lowest barrier items to contribute to vscode and don't require a lot of understanding of the extension to contribute, so I encourage to give it a shot!

https://code.visualstudio.com/docs/editor/userdefinedsnippets

Here is the file to edit: https://github.com/PowerShell/vscode-powershell/blob/main/snippets/PowerShell.json

Preferred if in the PR you include a screen capture of the snippet in action and showing all the tab stops working correctly.

JustinGrote avatar Oct 16 '24 20:10 JustinGrote

Anticipated this, so have a PR. Ill just add the screen captures you mentioned :)

ArieHein avatar Oct 16 '24 20:10 ArieHein