是否有关于如何用注释记录JavaScript文件的约定?像函数签名,示例等 [英] Is there a convention on how to document a JavaScript file with comments? Like function signatures, examples, etc

查看:106
本文介绍了是否有关于如何用注释记录JavaScript文件的约定?像函数签名,示例等的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

Java具有Javadoc,Python具有docstring. JavaScript中有类似的东西吗?

Java has Javadoc, Python has docstring. Is there something similar in JavaScript?

推荐答案

最常用的是JsDoc( https://jsdoc. app/).

The most commonly used is JsDoc (https://jsdoc.app/).

这也是一个从您的源生成文档的工具,并以JsDoc样式进行了注释: https://github.com/jsdoc3/jsdoc

This is also a tool that generates documentation from your sources, commented with JsDoc style: https://github.com/jsdoc3/jsdoc

这篇关于是否有关于如何用注释记录JavaScript文件的约定?像函数签名,示例等的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆