2013-08-06 8 views
10

Gibt es eine Möglichkeit, mit JSDoc in CoffeeScript geschriebenen Quellcode mit Anmerkungen zu versehen, wenn Sie in PHPStorm/WebStorm arbeiten? Wenn Sie in der IDE arbeiten, ist es sehr hilfreich, JSDoc verwenden zu können, um eine korrekte Codevervollständigung für Funktionen zu erhalten.CoffeeScript JSDoc-Unterstützung in PHPStorm/WebStorm

Ich habe diese letzte Frage gefunden: How to document CoffeeScript source code with JSDoc? Allerdings sind die Antworten und Kommentare nicht klar, ob es unterstützt wird oder was die richtige Syntax ist.

Antwort

6

Leider wird dies zur Zeit nicht unterstützt. Pleasze gerne eine Anfrage für diese Funktion zu youtrack

+3

Jetzt gibt es ein Problem bei: http://youtrack.jetbrains.com/issue/WEB-10414 –

-2

in Coffeescript Datei gibt es einen Weg, indem Code Grund Javascript zu verwenden, um zwischen „`“

 
coffee code 
` common javascript code ` 
coffee code 

gibt es vielleicht eine Möglichkeit, dies zu verwenden, zu setzen Ihre jsCode hier

 
coffee code 
` 
/** @constructor*/ 
` 
coffee code 

ich habe versucht, noch nicht diese Lösung ...

1

hier ist eine aktualisierte Antwort für alle, die über diesen Thread in th kommt Die Zukunft. WebStorm 2017.3 (die aktuelle Version zum Zeitpunkt der Erstellung) unterstützt JavaScript-Javadocs.

Die grundlegende Syntax ist folgende:

###* 
* Here is a simple description for foo 
* @param {Bar} bar - Some parameter to foo 
* @returns {Object} The thing that foo returns 
### 
foo = (bar) -> 

WebStorm Sie die Dokumentation geben wird, wenn Sie Strg + Q drücken.