wysublimowany tekst 2 - wyświetla jsdocs podczas pisania


12

Zainstalowałem pakiet JsDocs i używam go do dokumentowania mojego kodu. ATM Używam SublimeCodeIntel z, Alt+Clickaby przejść do dokumentacji, ale jest to dość denerwujące, szczególnie gdy chcesz po prostu spojrzeć na jeden mały szczegół, a następnie przewinąć do tyłu.

Zakładając, że mam taką funkcję 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;
}

Czy jest jakiś pakiet / wtyczka, która wyświetla dokumentację funkcji fooi jej parametry oraz zwracaną wartość podczas pisania foo((bez przewijania do dokumentacji)?


To byłoby coś ... ale jeszcze nic tam nie ma oczu ?!
— Dominik

Byłoby to niezwykle przydatne ...
— Laoujin

@Laoujin Nie znam się zbytnio na tym pomyśle; Jest ona podobna do intellisense - intellisense gdzie pokazuje co atrybuty mógłby korzystać. A może to coś innego?
— Raystafarian

Coś, co gdy wywołujesz funkcję, możesz zobaczyć JsDoc bez przechodzenia do implementacji funkcji. Idealnie byłoby to jakiś podpowiedź. Więc tak, intellisense ..
— Laoujin

To byłoby fantastyczne. Zgaduję, że ta funkcja nadal nie istnieje?
— theblang

Odpowiedzi:


1

Myślę, że sublimeCodeIntel już to robi domyślnie.

zapoznaj się z sekcją Korzystanie z pliku README, opisaną funkcją jest manual code intelligence.


Niestety tak nie jest. „Ręczna inteligencja kodu” najwyraźniej ogranicza się do wyświetlania name(function): rozpoznaje ją tylko jako funkcję, ale komentarze (a nawet parametry) nie są wyświetlane.
— Laoujin
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.