YUIDoc example代码高亮错误、生成API文档目录不按源文件注释顺序-阿里云开发者社区

开发者社区> 开发与运维> 正文
登录阅读全文

YUIDoc example代码高亮错误、生成API文档目录不按源文件注释顺序

简介:

1.如果发现yuidoc命令用不了,那就重装nodejs吧

   昨天不知道是清扫电脑的原因,yuidoc命令用不了(命令不存在),也没有找到好的解决方法,怒重装YUIDoc也不行。最后想了想,怒重装了nodejs,再装回YUIDoc,发现又可以了,原因还没找到。

2.YUIDoc的theme中的simple模板,sidebar.handlebar有写错。

   里面属性遍历的properties被写成了events

3.YUIDoc example代码高亮错误的解决方法

  使用过YUIDoc的人有可能会发现,写在example下的示例代码在文档生成之后可能出现代码不高亮、代码高亮错误等问题。

  这里提一个小技巧,先把example下所有的示例代码顶左,再使用Tab进行缩进,才不是出现高亮错误。

4.YUIDoc生成的API文档目录不按源文件注释顺序

   YUIDoc默认将所有的class、method、properties、events等按字母进行排序。-_-!!!

   而且这个是在生成文档时进行排序的,所以如果除去按字母进行排序这种默认行为。

   就必须修改YUIDoc的工具文件。修改C:\Users\Administrator\AppData\Roaming\npm\node_modules\yuidocjs\lib 下的 builder.js 文件

   第1313-1316行,就是这几句罪魁祸首,注释掉后就可以按源文件注释顺序,当然你也可以自己弄其他排序方法。

转载:http://www.cnblogs.com/lovesong/p/3341453.html

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

分享: