Erhabener Text 2 - Anzeige von Jsdocs während der Eingabe


12

Ich habe das JsDocs-Paket installiert und benutze es, um meinen Code zu dokumentieren. ATM Ich verwende SublimeCodeIntel Alt+Click, um zur Dokumentation zu springen, aber das ist ziemlich ärgerlich, vor allem, wenn Sie nur ein kleines Detail nachschlagen und dann zurückblättern müssen.

Angenommen, ich habe eine Funktion foowie diese:

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

Gibt es ein Paket / Plugin, das die Dokumentation der Funktion foound ihrer Parameter sowie den Rückgabewert anzeigt, wenn ich tippe foo((ohne zur Dokumentation zu scrollen)?


Das wäre etwas ... aber noch nichts da draußen ?!
Dominik

Dies wäre immens nützlich ...
Laoujin

@ Laoujin Ich bin nicht sehr vertraut mit dieser Idee; ist es ähnlich wie Intellisense - Intellisense , wo es zeigt , welche Attribute Sie können verwendet werden . Oder ist es etwas anderes?
Raystafarian

Wenn Sie eine Funktion aufrufen, können Sie JsDoc anzeigen, ohne zur Funktionsimplementierung zu wechseln. Idealerweise wäre dies eine Art Tooltip. Also ja, Intellisense ..
Laoujin

Das wäre fantastisch. Ich vermute, diese Funktion existiert noch nicht?
Theblang

Antworten:


1

Ich denke, sublimeCodeIntel macht dies bereits standardmäßig.

Weitere Informationen finden Sie im Abschnitt Verwenden der Readme-Datei. Die von Ihnen beschriebene Funktion ist manual code intelligence.


Dies ist leider nicht der Fall. "Manual Code Intelligence" beschränkt sich anscheinend auf die Anzeige name(function): Es erkennt es nur als Funktion, aber Kommentare (oder sogar Parameter) werden nicht angezeigt.
Laoujin,
Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.