如何在 JSDOC 中将 API 文档与内部函数文档分开答案

【问题标题】：How to separate API doc to internal functions doc in JSDOC如何在 JSDOC 中将 API 文档与内部函数文档分开
【发布时间】：2016-02-07 21:25:36
【问题描述】：

我有两个代表一个模块的 .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 部分获得所有功能，这对内部模块文档很有用。 但是如何选择一些要在 API 视图中记录的函数以及如何生成呢？

【问题讨论】：

标签： javascript node.js jsdoc jsdoc3

【解决方案1】：

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

【讨论】：