直接从源代码生成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 ，但它不是我正在寻找的。 任何人都可以对此有所了解吗？

我已经使用Yuidoc为我的项目。 它不读取代码，只有像@class，@module，@method等Yuidoc标签…包装在注释块中，如下所示：/ ** * /您可以使用它作为NodeJs的扩展名，并通过input你生成的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类的一部分。 因此，如果在计算（a，b）之后有一个名为drawGUI（）的方法，并且它应该属于其他类（例如Graphics），则应该注意，在另一个@class标记中也应该注意，就像上面的示例中一样。

注意：从我的观点来看，编写注释块可以帮助您在开发过程中提高代码质量，甚至可以在发生问题之前帮助您发现问题。

Interesting Posts