标签: esdoc

是否可以使用ESDOC记录javascript普通对象?

ESDOC似乎只针对ES6级风格.

有没有办法记录像以下的普通对象:

/**
 * ???
 */
var Foo = {
    /**
     * ???
     */
    info: true
};

export default Foo;
Run Code Online (Sandbox Code Playgroud)

即使使用ES6类样式,如何记录静态属性,如:

class Bar {
}

/**
 * ???
 */
Bar.info = true;

export default Bar;
Run Code Online (Sandbox Code Playgroud)

javascript documentation esdoc

9
推荐指数
1
解决办法
593
查看次数

如何在ESDOC中记录对象文字

文档没有提到它.

https://esdoc.org/manual/usage/tags.html

任何人都知道如何在ESDoc中记录对象文字,并生成一个报告,用于描述具有所有方法和值的对象.想知道如何记录以下标记.

/**
 * @??
 */
export default {
  /**
   * @??
   */ 
  myProperty: 1,
  /**
   * @??
   */
  myFunction: () => {}
}
Run Code Online (Sandbox Code Playgroud)

javascript esdoc

6
推荐指数
0
解决办法
151
查看次数

使用esdoc作为jsx文件

我想为.jsx文件生成文档

.esdoc.json:

{
   "source": "./src/",
   "destination": "./doc" 
}
Run Code Online (Sandbox Code Playgroud)

esdoc只需使用.js文件./src生成文档.

那么如何配置esdoc为.jsx文件生成文档?

jsx reactjs esdoc

1
推荐指数
1
解决办法
334
查看次数

ESDoc:忽略特定文件

尝试记录JavaScript文件时发生错误。为了解决这个问题,该策略将遵循不同的方向。我们的目标是忽略问题的原因,因为代码做了我们想要的。

对于这个项目,我们使用ESDoc来生成JavaScript文档。但是,如前所述,ESDoc解析器行为不承认我们的文件之一。通过解决ESDoc功能,我们发现没有简单的解决方案可以忽略特定目录中的某些文件。foo.js

所以我们的问题是:

有什么方法可以告诉ESDoc忽略特定文件目录吗?

我们研究了这个问题,但一无所获。请不要在解决方案上误解我们的要求,我们确实忽略了可用功能。

感谢您的时间。

javascript documentation esdoc

1
推荐指数
1
解决办法
660
查看次数

标签 统计

esdoc ×4

javascript ×3

documentation ×2

jsx ×1

reactjs ×1