Skip to content

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

Open

Description

@MaulingMonkey

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions