频道导航

哪种评论文档格式更适合JavaScript？

2019-05-03 JavaScript 前端之家

前端之家收集整理的这篇文章主要介绍了哪种评论文档格式更适合JavaScript？，前端之家小编觉得挺不错的，现在分享给大家，也给大家做个参考。

@H_301_0@

对于生成 HTML文档的格式,JavaScript和处理器是否有任何注释文档格式？

目前我正在使用VSDoc xml注释在开发时提供IntelliSense帮助,但据我所知,没有文档生成器用于此类注释.
所以,我的问题可能听起来像：是否有任何实用程序将VSDoc注释从JavaScript文件转换为HTML？

解决方法

您是否查看过JavaDoc或VSDoc或JSDoc或类似内容的自动生成的文档.

它们都很难看且不可读.

解决方案是双重的

> annotate your code with docco
>手写您的API文档.

还有第三个选项可以彻底改变我们自动生成文档的方式,如果可以的话请做.

上一篇：javascript – window.requestFile 下一篇：javascript – RxJs：zip运算符的有

猜你在找的JavaScript相关文章

Javascript中的事件冒泡与捕获

事件冒泡和事件捕获起因：今天在封装一个bind函数的时候，发现el.addEventListener函数支...

作者：前端之家时间：2021-02-22

搞懂js中小数运算精度问题原因及解决办法

js小数运算会出现精度问题 js number类型 JS 数字类型只有number类型，number类型相当于其...

作者：前端之家时间：2021-02-22

搞懂：前端跨域问题JS解决跨域问题VUE代理解决跨域问题原理

什么是跨域跨域：广义的跨域包含一下内容： 1.资源跳转（链接跳转，重定向跳转，表单提...

作者：前端之家时间：2021-02-22

前端对base64编码的理解，原生js实现字符base64编码

@ "TOC" 常见对base64的认知(不完全正确) 首先对base64常见的认知，也是...

作者：前端之家时间：2021-02-22

搞懂：MVVM模型以及VUE中的数据绑定数据劫持发布订阅模式

搞懂：MVVM模式和Vue中的MVVM模式 MVVM MVVM ：的缩写，说都能直接说出来：模型，：视图...

作者：前端之家时间：2021-02-22

js判断浏览器是否支持webGL

起因是我之前开发的网页，用到了three.js制作了一个3d的旋转球体效果。在各种浏览器上运行...

作者：前端之家时间：2021-02-14

js判断undefined和null

js判断undefined js判断null js判断null和undefined

作者：前端之家时间：2021-02-14

将文字自动转为banner打印形式的工具

http://patorjk.com/software/taag/

作者：前端之家时间：2021-02-14

聊一聊 bootstrap 的轮播图插件

今天做工作的时候，轻车熟路的做完，又用到了bootstrap的轮播图，觉得有必要安利一下这个插...

作者：前端之家时间：2021-02-14

js实现图片无缝循环跑马灯

html 代码 css js代码 function mylsRunHorseLight() { if (mylsTimer != null) { clearIn...

作者：前端之家时间：2021-02-14

最新文章