jsdoc

CoffeeScript JSDoc支持PhpStorm / WebStorm

在PHPStorm/WebStorm中工作时,有没有办法使用JSDoc来标注在CoffeeScript中编写的源代码?但是,答案和评论不清楚是支持还是正确的语法.不幸的是,目前不支持此功能.Pleasze随时向youtrack提交此功能的请求

如何使JavaScript功能在Eclipse“Outline View”中可见?

我有这样的代码,但如果在匿名函数中定义了函数的轮廓,则无法打开–类没有问题.如何概述一些东西2–请分享一些提示?我可以将所有函数标记为构造函数,但它是无效的方法.我测试了所有过滤选项,jsdoc和学习Eclipse首选项,但不知道如何在大纲视图中使something2可见?解决方法@memberOf注释中有一个小错字.改为资本O,它应该正常工作:如果适当,删除@constructor注释,以获取outline3中的something3()而不是构造函数.Here是一个类似的问题.按照答案中的链接获取更多信

参数 – JSDoc中的文档破坏函数参数

以前我一直记录我的对象参数如下:但我不确定最好的方法是使用结构化函数参数.我只是忽略对象,定义它不知何故或什么是最好的记录方法?我觉得我上面的方法并不明显,该函数期望一个对象而不是两个不同的参数.我可以想到的另一种方式是使用@typedef,但这可能会是一个巨大的混乱?解决方法这是它的意图,就我在jsdoc3repo可以找到:所以,你的第一个例子是非常正确的.更深层次的另一个例子:

_Best实践JSDoc’的Javascript文件写在“显示模块模式”风格?

我不习惯googleJSstyle指南介绍了有关JSDoc的内容:建议仅使用可用标记的一部分,以及其他建议.现在,我想出了这个模板:我应该在这里使用JSDoc标签@function或@memberOf,还是两者兼而有之?返回条款是否应该被JSDoc’mented?有没有人知道一个好的,实用的JSDoc风格指南小项目?

如何在JavaScript中返回文档

我正在为浏览器应用程序在工作中编写自己的图书馆,并且我有同样的旧问题决定如何评论代码.我试图遵循JsDoc语法,但可能会继续GoogleClosureCompiler的方式.我可能最终在文档中使用两个@return和@returns标签,仅用于可移植性(当我设置文档的自动生成时).现在,问题是,你如何记录一个自定义匿名对象从一个函数返回?例如:JsDoc有一个例子,说明如何使用@param来记录某