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

Polish: Automatic multi-line doc comments / templating #291

Open
MaulingMonkey opened this issue Jul 4, 2017 · 0 comments
Open

Polish: Automatic multi-line doc comments / templating #291

MaulingMonkey opened this issue Jul 4, 2017 · 0 comments

Comments

@MaulingMonkey
Copy link
Collaborator

Adding a new line after a /// style comment in C# automatically prefixes the line with ///. Might be able to reuse the existing autoindent code for similar in Rust?

Prefixing an existing C# function with /// on a new line also causes the autogeneration of xml tags for parameters, returns, etc. Rust doesn't have an enforced equivalent, but it sounds like rustdoc would recognize the following convention which could be generated instead ( http://brson.github.io/2012/04/14/how-to-rustdoc ):

/// [cursor here]
/// 
/// # Arguments
/// 
/// * `param1` - ...
/// * `param2` - ...
/// 
/// # Return Value
/// 
/// ...

I'm also planning to parse similar conventions for signature help providers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Syntax (Lexer/AST)
Awaiting triage
Development

No branches or pull requests

1 participant