Tag: 文档 生成

直接从源代码生成JavaScript文档

我正在寻找一种工具来生成JavaScript函数和属性的文档,即使没有与这些函数或属性(如Doxygen)相关的适当格式的注释块。 JSDoc和其他一些文档工具之间的比较提到,JSDoc可以parsing源代码来生成文档,即使没有注释块(就像我上面提到的Doxygen一样)。 他们说所有其他工具只parsing注释块。 我根据这个指令从npm(在节点上)安装了JSDoc 3.3.0-alpha4,我试图为我的项目生成文档。 据我所见JSDoc不会生成任何文档的function或属性,没有正确的注释与相关的JSDoc标志。 我知道JSDoc已经经历了很多迭代,这个function已经被删除,或者我没有使用正确的开关? 我试图检查命令行选项,但找不到任何开关。 我只是这样使用它: ./node_modules/.bin/jsdoc -r -l my_project –destination doc/ 我知道还有其他工具可以自动添加文档块的代码,例如smartcomments ,但它不是我正在寻找的。 任何人都可以对此有所了解吗?