-
Notifications
You must be signed in to change notification settings - Fork 78
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Snippet for Documentation #82
Comments
I agree with @guillermooo on keeping the snippets limited and basic. We don't want to add a bunch that will be coming up as people type. The one (non basic) snippet I would really like to add is one for the beginning script documentation (synopsis, description, parameters, etc). I think this will help encourage better documented code. @guillermooo and @vors, what do you think? |
I like this idea. How it should be triggered? |
That works, or would something like |
As I said, I don't use snippets (which I probably should start right now), so I don't have any strong opinion. Maybe |
Requirements:
I don't know what a good name would be, but I favor abbreviations that are close to but not always exactly real words. Specially so if the snippet is complex. This has the advantage, in my opinion, that you have to intentionally type the abbreviation to get the snippet instead of ST inserting a whole lot of text out of nowhere. For example, in Python there's a With that said, any of these are ok with me:
In any case, as a general rule I wouldn't have more than three Also, another mnemonic I use is: the longer the snippet, the longer its trigger. For example, |
Sounds good. I'll work on pulling this together and we can discuss more once it's created. Thanks! |
We should add a snippet for documentation. https://technet.microsoft.com/en-us/magazine/ff458353.aspx is the closest I found to a published standard.
Their example is:
The text was updated successfully, but these errors were encountered: