大大们好 , 最近在网上看到了一个这样的网http://www.css88.com/doc/underscore/docs/underscore.html,左边是源码分析,右边是源代码,不知道是不是node工具生成的。不知道哪位大大知道怎么弄。
大大们好 , 最近在网上看到了一个这样的网http://www.css88.com/doc/underscore/docs/underscore.html,左边是源码分析,右边是源代码,不知道是不是node工具生成的。不知道哪位大大知道怎么弄。
根据你这个网站和undercore源码,简单对比看了下,应该是自动生成的帮助文档。无非就是通过正则得到源码中的约定的注释部分(该注释部分即为文档内容),然后结合markdown语法进行显示。
类似的工具应该有,而且使用ndoe的gulp,grunt之类的要实现这个问题也不大,当然如果要处理得很好,还是要花一些功夫和心思的。
一般还会对源码的注释格式有一定的要求,得到的内容才能真正接近真正意义上的“帮助文档”。
试试这个,是不是你要找的,没有细看,只是简单感觉了下,貌似是提取注释生成帮助文档的东东:
https://www.npmjs.com/package/gulp-documentation
如果是的话,在评论中,麻烦说一下。
10 回答11.1k 阅读
6 回答3k 阅读
5 回答4.8k 阅读✓ 已解决
4 回答3.1k 阅读✓ 已解决
2 回答2.6k 阅读✓ 已解决
4 回答2.4k 阅读✓ 已解决
3 回答2.3k 阅读✓ 已解决
underscore
是用docco
这个工具来生成文档的在npmjs上有相关的gulp插件,不过这个命令简单,不用插件也行。
文档生成工具docco