12

I installed the JsDocs package and use it to document my code. ATM I'm using SublimeCodeIntel with Alt+Click to jump to the documentation, but this is quite annoying, especially when you just want to look up one little detail and then have to scroll back.

Assuming I've got a function foo like this:

/**
 * foo does some multiplication magic
 * @param  {Number} bar var number 1
 * @param  {Number} baz var number 2
 * @return {Number}     this equals bar*baz
 */
function foo(bar, baz) {
    return bar*baz;
}

Is there any package/plugin that displays the documentation of the function foo and its params and its return value when I type foo( (without scrolling to the documentation)?

  • That would be something... but nothing out there yet ey?! – Dominik Jul 14 '14 at 0:33
  • This would be immensely useful... – Laoujin Jan 30 '15 at 12:43
  • @Laoujin I'm not too familiar with this idea; is it similar to intellisense - intelligent code completion where it shows what attributes you could use. Or is it something else? – Raystafarian Feb 2 '15 at 14:04
  • Something that when you call a function you can see the JsDoc without going to the function implementation. Ideally this would be some sort of tooltip. So yes, intellisense.. – Laoujin Feb 2 '15 at 14:50
  • This would be fantastic. I am guessing this feature still does not exist? – theblang Mar 27 '17 at 21:54
1
+50

I think sublimeCodeIntel already does this by default.

please refer to Using section of the README, the feature you described is manual code intelligence.

| improve this answer | |
  • Unfortunately this is not the case. "Manual Code Intelligence" is apparently limited to displaying name(function): It only recognizes it as a function but comments (or even parameters) are not shown. – Laoujin Feb 5 '15 at 12:51

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.