Skip to content
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

Creating a comment doc block #20

Closed
jrieken opened this issue Jan 26, 2016 · 7 comments
Closed

Creating a comment doc block #20

jrieken opened this issue Jan 26, 2016 · 7 comments

Comments

@jrieken
Copy link
Contributor

jrieken commented Jan 26, 2016

From @TheColorRed on January 21, 2016 2:21

Is there anything that will allow for shorthand creation of documentation?

So for example, in C# if I type:

/// and press Enter

It would create a doc comment block

/// <summary>
///     Summary of my item
/// </summary>

It would add things such as:

  • Summary
  • Parameters
  • Return
  • Etc.

Copied from original issue: microsoft/vscode#2140

@jrieken
Copy link
Contributor Author

jrieken commented Jan 26, 2016

From @Tyriar on January 21, 2016 5:25

I believe you could do this with an extension

@jrieken jrieken self-assigned this Jan 26, 2016
@jrieken
Copy link
Contributor Author

jrieken commented Jan 26, 2016

From @weinand on January 21, 2016 9:11

@TheColorRed Please try snippets: https://code.visualstudio.com/docs/customization/userdefinedsnippets

@jrieken
Copy link
Contributor Author

jrieken commented Jan 26, 2016

From @TheColorRed on January 21, 2016 16:9

I did do snippets as a final, but you can't have a snippet of /// so I had to use text instead. However, it would be nice if either:

  • The editor picked up that /// was a saved snippet
  • That this doc feature was built into the editor

@jrieken
Copy link
Contributor Author

jrieken commented Jan 26, 2016

From @alexandrudima on January 26, 2016 11:15

@TheColorRed Would you expect that typing /// prepopulates the contents in the doc comment with the parameters and return type of the current method?

cc @jrieken : would be a nice rich language feature

@jrieken
Copy link
Contributor Author

jrieken commented Jan 26, 2016

The omnisharp extension should handle that

@jrieken
Copy link
Contributor Author

jrieken commented Jan 26, 2016

From @TheColorRed on January 26, 2016 15:32

@alexandrudima Yeah, that is what I was thinking would happen. It would also be nice if it was supported in other languages as well (at least eventually).

@DustinCampbell
Copy link
Member

This is a duplicate of #8.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants