PhpStorm / WebStorm中的CoffeeScript JSDoc支持

Posted 2021-04-16

在phpStorm / WebStorm中工作时，有没有办法使用JSDoc来注释用CoffeeScript编写的源代码？在IDE中工作时，能够使用JSDoc为函数正确完成代码是非常有帮助的。

我发现了这个过去的问题：How to document CoffeeScript source code with JSDoc?然而，答案和评论并不清楚是否支持或正确的语法是什么。

答案

不幸的是，目前不支持此功能。 Pleasze随时向youtrack提交此功能的请求

另一答案

以下是将来遇到此主题的任何人的更新答案。 WebStorm 2017.3（撰写本文时的当前版本）支持CoffeeScript javadocs。

基本语法是这样的：

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

当您按ctrl + Q时，WebStorm将为您提供文档。

另一答案

在coffeescript中有一种方法可以通过在“`”之间包含代码来使用基本的javascript

coffee code
` common javascript code `
coffee code

有可能使用它来将你的jsCode放在这里

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

我没试过那个解决方案......