What’s mining: understanding YARD
A few weeks have passed since RubyMine 3.1 release and RubyMine 3.1.1 bugfix update is almost ready.
However today I want to show you some new cool feature — coming YARD support (http://yardoc.org). We’ve received a good number of votes for this YARD and external docs support in our tracker: RUBY-5590 and RUBY-3309. And voila, your votes did the trick!
Now let me show you what we are working on!
First, RubyMine understands YARD tag annotations syntax in ruby comments as well as in plain rdoc files.
Then, RubyMine is smart enough to extract type annotations from the YARD annotated comments. On the screenshot below you can see that the inferred type of the
black_box method is String, this means that you’ll get accurate code completion and validation.
But that’s not all, you also get code completion according to the @param types in method bodies.
There is still a lot to be discussed and done, however feel free to tell us what features you would like to see in the next version of RubyMine as far as documentation functionality is concerned.
Develop with pleasure!
-JetBrains RubyMine Team
Subscribe to Blog updates
Thanks, we've got you!
RubyMine 2023.3 EAP Update
Hello everyone! We’re back with an update on the state of the 2023.3 Early Access Program. You can download the latest EAP build from our website, via the free Toolbox App, or by using snaps for Ubuntu. Here are the biggest highlights of this release: Performance improvements As we me…
The RubyMine 2023.3 Early Access Program Is Open!
Hello everyone, The third RubyMine Early Access Program of 2023 is underway! The key change in the first EAP build is an important indexing optimization. By refactoring our code base, we’ve doubled RubyMine’s indexing speed compared to v2023.1. This is particularly noticeable when working…
Performance Improvements in RubyMine 2023.1
Hello everybody, The new release is fast approaching, so it’s time to unveil the performance enhancements you can expect from RubyMine 2023.1. Faster code completion When developing and supporting RubyMine, we analyze a great load of anonymized usage data. A lot of recent data pointed to the fact t…
RubyMine 2023.1 EAP5 Is Out!
Hello everyone, RubyMine 2023.1 EAP5 is now available! Below you can find the most notable features in this build. We encourage you to try them out and share your feedback in the comments or in our issue tracker. Migration of Ruby code to the Symbol API In order to improve code insight actions such…