JSDoc已经比较成熟了,大家用起来!用起来!
话说JSDoc 3.3.2 输出示例代码 windows/linux换行不兼容问题
生成的文档页面明明在windows下格式是好的,换行业是正常的, 偏偏传到服务器上就变一行了,深入代码看了一下,主要是浏览器 对<code>标签中的windows和linux换行符识别有问题,尝试了一下 只要将换行符替换成<br>标签就可以了,进一步深入查看JSDOC源码 位置:
C:\Users\admin\AppData\Roaming\npm\node_modules\jsdoc
发现示例代码格式化是在
C:\Users\admin\AppData\Roaming\npm\node_modules\jsdoc\
templates\default\tmpl\example.tmpl
中实现的, 只需要将
<pre class="prettyprint"><code><?js= self.htmlsafe(example.code) ?></code></pre>
其中的 self.htmlsafe(example.code) 替换成
self.htmlsafe(example.code).replace(/(\\r\n|\n|\\r)/ig, '<br>')
就可以了
JSDoc 3.3.2