піднесений текст 2 - відображення jsdocs під час введення тексту


12

Я встановив пакет JsDocs і використовую його для документування свого коду. Банкомат, з яким я використовую SublimeCodeIntel, Alt+Clickщоб перейти до документації, але це дуже дратує, особливо коли потрібно просто переглянути одну дрібницю, а потім доведеться прокручувати назад.

Припустимо, що у мене є така функція foo:

/**
 * 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;
}

Чи є якийсь пакет / плагін, який відображає документацію функції fooта її парами та її повернене значення під час введення тексту foo((без прокрутки до документації)?


Це було б щось ... але нічого там ще очей ?!
— Домінік

Це було б надзвичайно корисно ...
— Laoujin

@Laoujin Я не надто знайомий з цією ідеєю; це схоже на intellisense - інтелектуальне завершення коду, де він показує, які атрибути ви можете використовувати. Або це щось інше?
— Raystafarian

Те, що під час виклику функції ви можете побачити JsDoc, не переходячи до реалізації функції. В ідеалі це буде якась підказка. Так так, intellisense ..
— Laoujin

Це було б фантастично. Я здогадуюсь, ця функція все ще не існує?
— mattblang

Відповіді:


1

Я думаю, sublimeCodeIntel вже робить це за замовчуванням.

будь ласка, зверніться до розділу Використання README, описаної вами функції manual code intelligence.


На жаль, це не так. "Інструкція з ручного коду", очевидно, обмежується відображенням name(function): він розпізнає його лише як функцію, але коментарі (або навіть параметри) не відображаються.
— Laoujin
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.