Feature Request: Syntax Highlighting of doc comments

[acheronfail]

vim's Rust plugin has implemented syntax highlighting for code blocks in doc comments (which is awesome!).

I think it would be awesome to have this for Sublime as well.

Here's a screenshot of what I'm talking about:

[CreepySkeleton]

@ehuss what do you think about it? I could give it a shot if you don't mind

[ehuss]

Feel free to give it a try, but I don't think it is possible. I don't think the embed key will be able to strip out the /// line prefixes.

[CreepySkeleton]

It doesn't, I'm trying to make it work by explicitly adding these prefixes to the syntax.

By the way, could you please describe how you work on .sublime-package.? I can't find a "getting started" guide on this.

[ehuss]

I'm not sure how that would work. If it requires massive modifications to the syntax, I probably wouldn't want to do that.

Syntax definitions are documented here: https://www.sublimetext.com/docs/3/syntax.html
Scope name guidelines are here: https://www.sublimetext.com/docs/3/scope_naming.html
I use PackageDev which makes it easier: https://github.com/SublimeText/PackageDev
Sublime has a built-in build system for running tests.

I'm not sure if there are any guides, but it shouldn't be too difficult to figure out.

[CreepySkeleton]

In short

• add Prefixed Markdown.sublime-syntax file, which is essentially a copy of Sublime's own distribution. This is the file which most changes come into. (I'm working on it)
• add markdown-comment context to Rust Enchanced.sublime-syntax which simply includes all the stuff in Prefixed Markdown.sublime-syntax, so the RustEnchanced's own grammar stays mostly intact.

I'm not sure if there are any guides, but it shouldn't be too difficult to figure out.

Yeah, I already have figured it out. Actually I was asking if there's a way to see changes to the syntax 'on the fly', with no need to repackage the repo and moving it to Installed Packages folder.

[ehuss]

a copy of Sublime's own distribution

I don't think I would want to make a change like that. We are trying to get the syntax definition in sync with sublime's official one, and I would be pretty sure that change wouldn't be accepted.

if there's a way to see changes to the syntax 'on the fly', with no need to repackage the repo and moving it to Installed Packages folder.

Ah, that shouldn't be necessary. Uninstall "Rust Enhanced", make a git clone of this repo into sublime's Packages directory. Sublime will then auto-update every time you save the file. Just beware, if you have other windows open with large projects, Sublime will have to re-index every one, so it can be a little rough on the CPU if there are a lot of open windows/files.

[CreepySkeleton]

I don't think I would want to make a change like that. We are trying to get the syntax definition in sync with sublime's official one, and I would be pretty sure that change wouldn't be accepted.

Oh, I didn't think about it. Well, let's see what we can do without tricks like that...

[louisdevie]

Hello,
I don't know what's the state of this issue, but it looks like you can't embed Markdown inside Rust because the default Markdown syntax already include rust and this causes a recursion error (see these issues: #1534 and #2444).

A (not very clean) solution would be to have a custom simplified* Markdown syntax embedded inside the rust-enhanced one. Looking at the comments above, it looks like this solutions is not acceptable, but given that this has not been updated since almost three years, I wanted to revive this issue anyway.

* I have no experience whatsoever, but I think the default Markdown syntax is overkill for 99% of Rust documentation comments