Allow customization of default values for comment help fields like SYNOPSIS, LINK, and NOTES

[darksidemilk]

A customizable file header type situation would be pretty cool.
Things like a default synopsis that includes a custom heading with author that pulls current user, update time, created time, stuff like that.
Also a .LINK comment with a customizable text entry to make linking to internal online powershell documentation easier.

Also thanks for making the comment block snippet at all, it's amazing.

[pcgeek86]

I would recommend using VSCode User Snippets for this sort of custom header. Does this seem like a reasonable solution to you?

http://stackoverflow.com/questions/29995863/how-to-add-custom-code-snippets-in-vscode

[daviwil]

I think in this case he's asking for added customization in the new comment help block feature we added today. It's definitely something we can do but might not come immediately.

[darksidemilk]

@daviwil got it. I certainly wouldn't expect it to be an immediate thing. Just noticed the request in the change log for feature requests regarding the comment block and wanted to do my small part.

[daviwil]

Absolutely, I appreciate your input!

[rkeithhill]

I use a feature like this in R#. It lies between snippets and a built-in expansion like the current comment help. The nice thing about snippets is that users can easily take the an existing snippet and customize it to suite their taste. But you can't auto-inject custom info (like username, time, etc).

The problem with built-in approach is that they are either not customizable or hard to customize - usually resulting in even more settings. And every new built-in expansion adds even more settings :-(

In R# there is a feature called templates that support live templates, surround templates and file templates. You can specify various different pieces of environment data like filename, time, etc. Perhaps we could provide the template text as something the user could override and be able to use either predefined variables or PowerShell expressions to get the desired data $env:USERNAME.

[daviwil]

Hmmm, I wonder if there's a PowerShell module that knows how to create text from templates ;)

But seriously though, I agree. It'd be really nice if there was a way to have project-specific templates for dynamic snippets. This actually could be something that Plaster provides when the new framework API is ready.

[rkeithhill]

Yeah, there's definitely a "templating" aspect to this.

It'd be really nice if there was a way to have project-specific templates for dynamic snippets

Just need a way to register a completion trigger with VSCode. I don't know if that exists though. With R#, I get a standard company copyright file header when I type fhdr tab.

[daviwil]

This is something I plan to enable in the PSES APIs. Since we know when the file is being changed, we can invoke autocompletion providers that would be registered with our APIs.