有什么好的文档生成工具没???

plzzz 2012-12-14 12:06:58
今天用了YUIDOC来自动生成帮助文件,感觉还不错,下载安装了,随便拿了一个以前写的JS文件测试了下,
只要写代码的时候养成写注释的习惯就什么不用管了.感觉生成的文件很专业,显示和YUI3 API 帮助文档一样

,生成的文件有一点不好就是还是会引用到YUI服务器上的一些脚本...
为了要让生成的文件断网也能看,花了一天的时间,修改default theme的JS脚本文件,把所有要引用到的JS全都下载好,放一个文件(这一步很简单,因为YUI服务器会将运行所需零碎JS,直接combine成一个单文件发过来,复制就好了)
chm文件有很多限制,比如不支持ajax,json等方式从压缩好的chm内部取文件(用flash我没试过行不行),
下边是最后用官网下载的HTML Help Workshop压成chm之后的样式,在断网下打开的测试

现在感觉真简单,一个简单的cmd命令就能拿到专业的帮助文档了,

支持自动补齐查找,左上角yui logo以后再替换了

可以勾选是否显示 private 属性 方法 等


pertty print 显示原始代码,查看单个方法源码时,window.scroll 精确到行






...全文
131 4 打赏 收藏 转发到动态 举报
写回复
用AI写文章
4 条回复
切换为时间正序
请发表友善的回复…
发表回复
plzzz 2012-12-14
  • 打赏
  • 举报
回复
yuidoc 的安装官网写的很详细了.看不太懂用Bing翻译(计算机语言方面bing比google翻译好多了)下就行了. HTML Help Workshop是微软的下载的东西 总的来说要压成CHM,要修改模板里的apidocs.js文件就好了,删掉ie不支持的router,pjax相关代码就就行了
ILOVE_ASPNET 2012-12-14
  • 打赏
  • 举报
回复
楼主教下我 这个东西如何正确安装的,有没有好点的安装图解
小飛不想飛 2012-12-14
  • 打赏
  • 举报
回复
代码都是手写,最多用一下插件,mark一下
rayaspnet 2012-12-14
  • 打赏
  • 举报
回复
引用 楼主 plzzz 的回复:
今天用了YUIDOC
JSDoc 怎么样?

87,907

社区成员

发帖
与我相关
我的任务
社区描述
Web 开发 JavaScript
社区管理员
  • JavaScript
  • 无·法
加入社区
  • 近7日
  • 近30日
  • 至今
社区公告
暂无公告

试试用AI创作助手写篇文章吧