Continue doc-comment on new line
See original GitHub issueHi,
Often when writing doc comments (lines starting with ///
or //!
) it would be nice if, when hitting enter, the next line would start with the same doc comment sequence. This is implemented in VSCode as well and I miss this feature every time when editing with Corrosion.
I wonder how difficult it is to teach the generic editor this trick for Rust code.
Issue Analytics
- State:
- Created 5 years ago
- Comments:7 (4 by maintainers)
Top Results From Across the Web
How to add a line break in C# .NET documentation
As of Visual Studio 2019, use <br/> for newlines in comments. ... This is a long comment so i want it to continue...
Read more >Handling of newline in RustDoc · Issue #120 - GitHub
The intention is that it removes extraneous newlines from simple text ... to keep the line length of the original Rust source reasonable, ......
Read more >Comment continuation (copy `//` to next line on enter) in VS ...
I'm finding myself writing a lot of doc comments in it lately, and it'd be great to have comment prefixes auto-inserted on newline....
Read more >How to Write Doc Comments for the Javadoc Tool - Oracle
The first line that begins with an "@" character ends the description. There is only one description block per doc comment; you cannot...
Read more >API documentation and comment standards | PHP - Drupal
This section contains standards related to all API docblocks. Syntax example: /** * Sample summary line. * * Next paragraph. Etc. */ (code...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
This will be done with TM4E. We are in the process of adding the remaining language-configuration features, then on enter actions that you use in vscode will be present, including the one you’ve described. So hold on tight or come help with contributions to the related issue in TM4E! 👍
Hey Lucas, thanks this gets rid of most of the problems! Maybe the generic editor (EDIT: or the TM4E tools rather) should allow a language specific version for the tabs vs. spaces setting overwriting the general
Text Editors
settings.The cursor is still placed weird on auto-close of doc-comment (see last comment).