如何在JSDOC中将API doc分隔为内部函数doc

Question

我有两个代表一个模块的.js文件。该模块将代表一个与其他模块一起使用的API，因此我想很好地记录这个API。

此处的文件和功能结构：

file1.js
    // Include these functions
    getCLO();      // Should appear in API doc view
    addCLO();      // Should appear in API doc view
    prepareCL();   // Should appear in internal module doc view not in API view

file2.js
    // Include these functions
    getLM();       // Should appear in API doc view
    addLM();       // Should appear in API doc view
    prepareLM();   // Should appear in internal module doc view not in API view

当我使用JSDOC时，我获得了Global部分中的所有功能，这对内部模块doc很有用。 但是如何选择要在API视图中记录的一些函数以及如何生成它？

Answer 1

您可以使用@private或@access来控制生成哪些函数