2013-08-06 64 views
10

Có cách nào để sử dụng JSDoc để chú thích mã nguồn được viết bằng CoffeeScript khi làm việc trong PhpStorm/WebStorm không? Khi làm việc trong IDE, nó rất hữu ích để có thể sử dụng JSDoc để hoàn thành mã thích hợp cho các hàm.Hỗ trợ CoffeeScript JSDoc trong PhpStorm/WebStorm

Tôi đã tìm thấy câu hỏi trước đây: How to document CoffeeScript source code with JSDoc? Tuy nhiên, câu trả lời và nhận xét không rõ ràng về việc liệu nó được hỗ trợ hay cú pháp thích hợp là gì.

Trả lời

6

Rất tiếc, tính năng này hiện không được hỗ trợ. Pleasze cảm thấy tự do để nộp đơn yêu cầu cho tính năng này để youtrack

+3

Hiện có sự cố tại: http://youtrack.jetbrains.com/issue/WEB-10414 –

-2

trong coffeescript có một cách sử dụng javascript cơ bản bằng cách bao gồm mã giữa "`"

 
coffee code 
` common javascript code ` 
coffee code 

có lẽ là một khả năng sử dụng điều này để đưa jsCode của bạn ở đây

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

tôi không cố gắng nhưng giải pháp mà ...

1

Dưới đây là một câu trả lời được cập nhật cho bất cứ ai đi qua chủ đề này trong ngày tương lai. WebStorm 2017.3 (phiên bản hiện tại của bài viết này) đã hỗ trợ cho CoffeeScript javadocs.

Cú pháp cơ bản là thế này:

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

WebStorm sẽ cung cấp cho bạn các tài liệu khi bạn nhấn ctrl + Q.