CODEWITHSUNDEEP
ruby
JackyJohnson
JackyJohnson

Reputation: 3126

Properly display tags within Ruby comments

I see in the Ruby core library source they sometimes have large blocks of comments with 

<code>some code</code>

and 

+someMethodName+

in them. I suppose the code tag is supposed to be rendered by the code editor. What IDE does it properly? I'm using Rubymine.

The attached image is how it looks for me:

enter image description here

Upvotes: 0

Views: 21

Answers (1)

the Tin Man
the Tin Man

Reputation: 160571

It's not supposed to be rendered by a code editor, it's rendered by RDoc. Some editors can display the information, but unless they implement everything RDoc does the resulting output will have artifacts.

See the RDoc documentation and the associated README for more information about how and what it does.

Upvotes: 1

Related Questions