是否有关于如何用注释记录 JavaScript 文件的约定？像函数签名、示例等
Posted
技术标签:
【中文标题】是否有关于如何用注释记录 JavaScript 文件的约定？像函数签名、示例等【英文标题】：Is there a convention on how to document a JavaScript file with comments? Like function signatures, examples, etc 【发布时间】：2013-09-02 23:36:30 【问题描述】：Java 有 Javadoc，Python 有 docstring。 javascript中有类似的东西吗？
【问题讨论】：
【参考方案1】：最常用的是JsDoc（https://jsdoc.app/）。
这也是一个从您的源代码生成文档的工具，以 JsDoc 样式注释：https://github.com/jsdoc3/jsdoc
【讨论】：
以上是关于是否有关于如何用注释记录 JavaScript 文件的约定？像函数签名、示例等的主要内容，如果未能解决你的问题，请参考以下文章
Java基础 | 如何用Javadoc Tool写规范正确的java注释
如何用javascript实现对文本域加粗,斜体和下划线效果的设置