发布了文章2018-01-23
Eslint(二):规则字典 字数:6190 阅读时间:30分钟 Standard规范+Angular规范集合 代码格式 indent {代码...} 规定使用几个空格进行缩进。第二个参数表示空格的个数,默认是2个,我们这个设置的是四格。 block-spacing {代码...} 规定单行代码两边加空格。第二个参...
发布了文章2018-01-06
前面,我们以一个实战案例来详细说明了如何在实际开发中使用JSDuck工具。但是,并不是所有的时候,代码的封装方式都受我们控制的。例如,如果我们使用了现在的几个主流框架AngularJS、React或者Vue的时候,代码的封装方式就必须按照框架定义的方式来构建。当我们的代...
发布了文章2018-01-06
上一篇文章我们讲述了JSDuck的详细用法。那么,本文笔者就以实例为基础,和大家一起,从零开始,搭建一个简单的API文档——我们的第一个API文档V0.0.1。
发布了文章2018-01-06
首先,咱们有一个前提,JSDuck对我们而言只是一个便于API查看的文档化工具。因此,只要它能够满足我们文档化的所有需求,并且优雅地显示出来就足够了。所以,这篇文章旨在告诉大家,在日常工作中,我们如何使用这个工具,至于里面的实现原理、编程思想或者自定义标...
发布了文章2018-01-06
笔者学习一门知识有一个习惯,就是会先去了解这门知识的一个大致历史框架,而后再学习具体的知识内容。这样做有以下两个目的:1.可以增添兴趣,对于越枯燥的知识越是有效。2.可以知道这门知识的来龙去脉,可以知道依托于这门知识,自己将会去向何方。毕竟古人也说过...
发布了文章2018-01-06
本文的旨在讲述如何从零开始搭建一个MarkDown文档展示工具。整个过程非常简单,咱稍微花五分钟就可以搭建一个定制化的MD文档解析器,是不是很酷呀!
发布了文章2018-01-06
在经历了数个上线的项目之后,笔者所在的团队已经沉淀了一个相对稳定版本的前端框架。因此,我们需要出具一套框架API文档,以便公司其他成员的使用和框架的后期维护。我们在对现在较主流的五个文档工具:JSDoc 3、YUIDoc、Dox、Docco、JSDuck分别作了调研和尝试,...