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

目录
相关文章
|
应用服务中间件 API nginx
一个超长时间的http api 的 nginx 超时错误 java.io.IOException: unexpected end of stream on Connection
一个长时间的http api 的 nginx 超时错误 直接访问IP是OK的。但是经过了中间一台域名机子,配置了nginx (基本上所有的超时时间timeout配置项都配置了足够的时间)的proxy_pass到这个IP上。
7402 0
|
数据可视化 PyTorch API
wandb安装注册及解决训练模型报API错误
wandb是Weight & Bias的缩写,一句话,**它是一个参数可视化平台**。 wandb强大的兼容性,它能够和Jupyter、TensorFlow、Pytorch、Keras、Scikit、fast.ai、LightGBM、XGBoost一起结合使用。
|
前端开发 JavaScript API
关于 SAP UI5 getSAPLogonLanguage is not a function 的错误消息以及 API 版本的讨论
关于 SAP UI5 getSAPLogonLanguage is not a function 的错误消息以及 API 版本的讨论
144 0
关于 SAP UI5 getSAPLogonLanguage is not a function 的错误消息以及 API 版本的讨论
|
存储 Java API
使用Java消费API的一个错误消息PKIX path building failed以及解决方案
使用Java消费API的一个错误消息PKIX path building failed以及解决方案
调用Hybris API时遇到的错误消息Cannot find user with uid如何解决
调用Hybris API时遇到的错误消息Cannot find user with uid如何解决
102 0
|
API
调用Gitlab API时报403错误
错误原因:conflict 请求冲突,Gitlab使用rack_attack做了并发访问的限制 解决方案: (1)避免多次重复调用 (2)将Gitlab的IP设置为白名单即可 步骤如下: 打开/etc/gitlab/gitlab.rb文件。
2609 0
|
弹性计算 算法 API
ECS API中Signature错误的排查方法
Signature的生成方法 将get中提交的参数(除了aks以外所有的参数)按照一定的组成规则拼成一个字符串,前面再加上GET&/&组成StringToSign,然后对StringToSign做 HMAC计算,以Access Key Secret+一个“&”号为HMAC计算的key,最终算出的字符串就是Signature。
2968 0
|
Java API 开发工具
帮你捋顺 API 网关的 API、SDK和错误排查
整理一下 API 网关资源和错误排查方法,让用户快速定位问题。
3121 0