什么是YUIDoc? YUIDoc会根据你写的代码注释生成API文档。 YUIDoc是个NodeJS应用,能将你的JS代码中的注释生成HTML格式的API文档。事实上,不仅是JS,任何支持块注释的语言都能使用。 安装 要安装YUIDoc,首先要安装好NodeJS,然后使用 npm -g instal ...
分类:
Web程序 时间:
2020-01-04 23:57:09
阅读次数:
166
团队合作开发javascript应用程序时,文档非常重要,但是以什么样规范编写文档、什么样的样式展现文档成为一个问题,目前javascript文档工具很多,有JsDoc、YUIdoc、JsDuck,笔者在对常见工具调研后,选择JsDuck,是因为: 1、JsDoc语法太过严格,稍微不符合解析规则就会...
分类:
Web程序 时间:
2015-07-08 00:30:50
阅读次数:
948
上面介绍了JS文档和Demo设计工具,本篇开始介绍一下注释的编写。SmartDoc使用的是YUIDoc的引擎,所以的注释规则都一样,先简单介绍下YUIDoc的注释编写。编写注释是一个很繁重的体力活,很多程序员都嫌麻烦不愿意做此事,但是在编写的过程,会让你注意到很多的细节和考虑一些没有想到的地方,会发...
分类:
其他好文 时间:
2014-10-10 10:53:24
阅读次数:
350
Grunt入门教程之三
Yuidoc插件
Yuidoc 是一个可以将代码注释生成HTML格式文档的工具,文档的生成完全基于JavaDoc风格的代码注释规则。
我们在写公共模块或者API的时候,往往会输出文档给调用者查看,这时候Yuidoc就是一个很好的助手。
下面介绍一下如何在Grunt中使用Yuidoc。
1234567891011121314151...
分类:
其他好文 时间:
2014-09-24 21:44:38
阅读次数:
241
实现模块化编程:require.js富交互网络框架:backbone.js模板引擎:underscore.jsjquery使用经验总结使用yuidoc.js生成api文档使用maven方法总结使用apachehttp server方法总结使用perforce方法总结使用svn方法总结学习使用play...
分类:
编程语言 时间:
2014-07-26 16:56:01
阅读次数:
290