社区
JavaScript
帖子详情
javascript的文档注释怎么弄?
kyousuke
2011-09-18 04:27:18
有标准的注释格式吗?
像ext或jquery的,发布的库里面都是没有注释的,他们是怎么做成注释文档的?又是怎么压缩的?
...全文
289
13
打赏
收藏
javascript的文档注释怎么弄?
有标准的注释格式吗? 像ext或jquery的,发布的库里面都是没有注释的,他们是怎么做成注释文档的?又是怎么压缩的?
复制链接
扫一扫
分享
转发到动态
举报
写回复
配置赞助广告
用AI写文章
13 条
回复
切换为时间正序
请发表友善的回复…
发表回复
打赏红包
hellNo
2011-09-19
打赏
举报
回复
帮顶啦
Gemini Dean
2011-09-19
打赏
举报
回复
学习学习
net_php2
2011-09-19
打赏
举报
回复
单行//
多行/* */
uncle_bacon
2011-09-19
打赏
举报
回复
上面说的都对
hi_allen_liu
2011-09-19
打赏
举报
回复
上面说的都对
sxdgundam
2011-09-19
打赏
举报
回复
ls正确,如果是要根据注释生成文档到没弄过
hch126163
2011-09-19
打赏
举报
回复
单行
//
/* */
多行
/**
*/
Acesidonu
2011-09-19
打赏
举报
回复
学习学习
秋叶随风飘落
2011-09-19
打赏
举报
回复
单行//
多行注释/* */
24K純帥
2011-09-19
打赏
举报
回复
学习~
shelless
2011-09-18
打赏
举报
回复
单行//
多行/* df
dfd
df
df
*/
碧海情天-赵亮
2011-09-18
打赏
举报
回复
嗯,JsDoc Toolkit 是基于 JavaDoc 开发的一款辅助工具,你只需要根据它使用说明里的约定在 JavaScript 代码中添加相应的注释,它就可以根据这些注释来自动生成API文档。
http://code.google.com/p/jsdoc-toolkit
豆虫
2011-09-18
打赏
举报
回复
标准都是人定的 Java有JavaDoc js自然也有
推荐一个:
http://cnmqw.iteye.com/blog/894707
【
JavaScript
】
文档
注释
详解
本文详细介绍了
JavaScript
中使用
文档
注释
的重要性,包括为何要写
文档
注释
,不使用
注释
的隐患,如函数成员的书写问题和调用时的功能使用问题。文章还详细讲解了JSDoc的各种官方标签,如@param、@returns、@author、@license等,并给出了多个示例,展示如何为函数、参数、返回值、对象属性等添加
注释
。此外,还提到了自定义标签,如@history和@date,以及如何使用JSDoc生成工具生成
文档
。
core-js
文档
生成:从代码
注释
到API
文档
本文详解core-js如何通过JSDoc
注释
和自动化工具链,将代码
注释
转化为高质量API
文档
。涵盖
注释
规范、构建流程、兼容性数据生成及
文档
结构,并结合实战案例展示从代码到
文档
的完整转化过程,助力开发者构建高效、准确的
JavaScript
polyfill
文档
体系。
js
文档
注释
本文介绍了
JavaScript
中
文档
注释
(JSDoc
注释
)的使用。JSDoc
注释
可用于生成 API
文档
、提高代码可读性和为 IDE 提供智能提示。文中阐述了其基本语法,列举了常见标签,如 @param、@returns 等,还提及对类和对象的
注释
,强调其对代码可维护性的重要性。
【VSCode插件】VS DocBlockr 便捷的生成 JS
文档
注释
VS Code插件DocBlockr是Atom的DocBlockr移植版,主要用于便捷生成
JavaScript
文档
注释
。虽然最初在HTML文件中可能无法正常使用,但在JS文件中能提升
注释
效率。遵循
JavaScript
开发规范,帮助编写函数
注释
。
Javascript
注释
以及Java
文档
注释
本文介绍了HTML和
JavaScript
中的
注释
用法,包括HTML的单行
注释
、
JavaScript
的单行及多行
注释
,以及Java
文档
注释
的详细解释。通过实际案例展示了如何在网页开发中使用这些
注释
。
JavaScript
87,987
社区成员
224,684
社区内容
发帖
与我相关
我的任务
JavaScript
Web 开发 JavaScript
复制链接
扫一扫
分享
社区描述
Web 开发 JavaScript
社区管理员
加入社区
获取链接或二维码
近7日
近30日
至今
加载中
查看更多榜单
社区公告
暂无公告
试试用AI创作助手写篇文章吧
+ 用AI写文章