aristotll / RubyDocAdder

README

---

Plugin link

Add document comments to Ruby functions in Intellij or RubyMine.

see https://www.jetbrains.com/help/ruby/documenting-source-code-in-rubymine.html for more info.

---

Move cursor to the function name, and press the shortcut to add the Ruby doc comments.

Shortcuts:

• ctrl + shift + P or alt enter in Windows and Linux
• ⌘ + ⇧ + P (command shift P) or ctrl enter in Mac os

---

---

Before

def encode!(test, num = 1, *several_variants, **new)
  ''
end

After

# @param [Object]  test
# @param [Fixnum]  num
# @param [Array]  several_variants
# @param [Hash]  new
# @return [String]
def encode!(test, num = 1, *several_variants, **new)
  ''
end