I've started playing around with JSDoc comments in a library I've built with Ruby2JS and it's nice that they're similar to YARD, and what's cool is I can easily generate TypeScript definitions without actually writing TS.

The only thing that's a little iffy is the syntax you have to use. Essentially my code has to look like this:

=begin*
 * This is way cool.
 *
 * @param name {string} Wowee
 * @param selector {string} Whoa
=end
  def self.target(name, selector)
    # etc.

In order to get this:

  /**
 * This is way cool.
 *
 * @param name {string} Wowee
 * @param selector {string} Whoa
*/

  static target(name, selector) {

I'm thankful that kind of multiline commenting does work in the Ruby > JS transpilation, but I'm wondering if there's anything else we can do to make it more seamless. Maybe something like this where it's just JS comment syntax embedded within?

  #/**
  # * This is way cool.
  # *
  # * @param name {string} Wowee
  # * @param selector {string} Whoa
  # */
  def self.target(name, selector)
    # etc.

Any thoughts @rubys ?