我正在寻找一种工具来生成 JavaScript 函数和属性的文档，即使没有与这些函数或属性相关联的适当格式的注释块（如 Doxygen 那样）。
JSDoc 与其他一些文档工具的比较提到，即使没有注释块（类似于 Doxygen，如上所述），JSDoc 也可以解析源代码以生成文档。他们说所有其他工具只解析评论块。
我根据此说明从 npm（在节点上）安装了 JSDoc 3.3.0-alpha4，并且我正在尝试为我的项目生成文档。据我所知，JSDoc 不会为没有带有相关 JSDoc 标志的正确注释的函数或属性生成任何文档。
我知道 JSDoc 经历了多次迭代，这个功能是否被删除或者我没有使用正确的开关？我试图检查命令行选项，但找不到任何开关。我只是像这样使用它：
./node_modules/.bin/jsdoc -r -l my_project --destination doc/
我知道还有其他工具可以自动将文档块添加到代码中，例如smartcomments，但这并不是我想要的。任何人都可以对此有所了解吗？
我在我的项目中使用了 Yuidoc。它不读取代码，只读取 @class、@module、@method 等 Yuidoc 标记... 像这样包裹在注释块中： /** */ 您可以将其用作 NodeJs 扩展并通过输入生成 api带有 Node cmd 并运行命令的 javascript 文件夹：
yuidoc .
如果您不知道如何使用它，一开始有点棘手。
例如，如果你有一个这样的 yuidoc 标签：
/**
* @class Claculator
* @method claculate
* @param {Number} a
* @param {Number} b
* @return {Number}
*/
function calculate(a, b) {
}
/**
* @class Graphics
* @method drawGUI
* @param {Number} x
* @param {Number} y
* @param {Number} z
* @return {Number}
*/
function drawGUI(x, y, z) {
}
@class 标签后面的所有方法/属性将在生成后成为 Calculator 类的一部分。因此，如果您在 calculate(a, b) 之后有一个名为 drawGUI() 的方法，并且它应该属于其他类，例如 Graphics，那么您应该在另一个 @class 标记中注意这一点，就像上面的示例一样。
注意：从我的角度来看，编写注释块可以帮助您在开发时提高代码质量，还可以帮助您在问题发生之前发现问题。