jsDoc -不排除标记为@private的方法

jsDoc是一种用于JavaScript代码文档化的标记语言和工具。它允许开发人员通过注释代码来描述函数、方法、类和变量的用途、参数、返回值和其他相关信息，以便生成清晰的文档。

jsDoc的主要作用是提供代码文档化和自动化文档生成。通过使用jsDoc注释，开发人员可以更好地理解代码的功能和用法，并且可以生成具有良好结构和易读性的文档。这对于团队协作、代码维护和项目文档化非常有帮助。

对于标记为@private的方法，它表示该方法是私有的，只能在当前类或对象内部使用，不能被外部访问或调用。私有方法通常用于封装内部逻辑，隐藏实现细节，提高代码的安全性和可维护性。

以下是jsDoc的一些常用标记：

• @param：用于描述函数或方法的参数，包括参数名称、类型和描述。
• @returns：用于描述函数或方法的返回值类型和描述。
• @throws：用于描述函数或方法可能抛出的异常类型和描述。
• @example：用于提供代码示例，展示函数或方法的使用方式。
• @see：用于引用其他相关文档或资源。

在腾讯云的产品中，与jsDoc相关的产品是腾讯云文档生成工具（Tencent Cloud Document Generator）。该工具可以根据代码中的jsDoc注释自动生成文档，并支持自定义模板和样式。您可以通过以下链接了解更多关于腾讯云文档生成工具的信息：

腾讯云文档生成工具：https://cloud.tencent.com/document/product/1159/44225