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.

Sign up for GitHub

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

Jump to bottom

Creating a comment doc block #2140

Closed
TheColorRed opened this issue Jan 21, 2016 · 7 comments
Closed

Creating a comment doc block #2140

TheColorRed opened this issue Jan 21, 2016 · 7 comments
Assignees
@jrieken
Labels
feature-request Request for new features or functionality

Comments

@TheColorRed
Copy link

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.
@Tyriar
Copy link
Member

Tyriar commented Jan 21, 2016

I believe you could do this with an extension

@weinand
Copy link
Contributor

weinand commented Jan 21, 2016

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

@TheColorRed
Copy link
Author

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

@weinand weinand added the editor label Jan 22, 2016
@alexdima
Copy link
Member

@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

@alexdima alexdima added the feature-request Request for new features or functionality label Jan 26, 2016
@jrieken jrieken added the c# label Jan 26, 2016
@jrieken
Copy link
Member

jrieken commented Jan 26, 2016

The omnisharp extension should handle that

@alexdima alexdima assigned jrieken and unassigned alexdima Jan 26, 2016
@TheColorRed
Copy link
Author

@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).

@jrieken jrieken mentioned this issue Jan 26, 2016
Closed
@jrieken
Copy link
Member

jrieken commented Jan 26, 2016

This issue was moved to dotnet/vscode-csharp#20

@jrieken jrieken closed this as completed Jan 26, 2016
@vscodebot vscodebot bot locked and limited conversation to collaborators Nov 18, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@jrieken jrieken

Labels
feature-request Request for new features or functionality
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@TheColorRed @jrieken @weinand @Tyriar @alexdima