特点 支持热更新 快速启动,依赖于 vite,无需另起服务 自动生成组件导航 ui 采用了vant-ui的样式 核心方法覆盖率达到了 92.86% 使用 yarn add vite-plugin-vue-docs -D // vite.config.js import { defineConfig } from "vite"; import vue from "@vitejs/plugin-vue"; import vueDocs from "vite-p…

一.现状 Vue框架在前端开发中应用广泛,当一个多人开发的Vue项目经过长期维护之后往往会沉淀出很多的公共组件,这个时候经常会出现一个人 开发了一个组件而其他维护者或新接手的人却不知道这个组件是做什么的.该怎么用,还必须得再去翻看源码,或者压根就没注意到这个组件 的存在导致重复开发.这个时候就非常需要维护对应的组件文档来保障不同开发者之间良好的协作关系了. 但是传统的手动维护文档又会带来新问题: 效率低,写文档是个费时费力的体力活,好不容易抽时间把组件开发完了回头还要写文档,想想都头大. 易出错…

近来前端组小盆友开发的类库越来越多,很多情况下彼此不知道写了些什么方法,为了更好的合作提高工作效率,找了个比较好的api文档生成方法.使用jsdoc-toolkit来自动生成js api文档. 一. 环境搭建 1) 首先要安装java环境,如果不太了解的参看:http://jingyan.baidu.com/article/e75aca85b29c3b142edac6a8.html 2) 安装jsdoc-toolkit 下载地址:http://code.google.com/p/jsdoc-to…

程序员最讨厌的两件事情,第一种是写文档,另一种是别人没有写文档.有没有直接根据vue组件生成文档的呢?当然是有的的.但第三方使用起来不一定能和现有项目结合使用,往往需要额外的注释用来标记提取信息.使用第三方的一些比较常见问题 文档提取信息不全面,可能有些信息你需要提取但是它又不支持.这种情况下就只能修改三方的插件源码了. 需要额为的注释信息来标记,例如 vuese 需要给方法 打 @vuese.@arg 等标记来提供方法信息. 俗话说自己动手丰衣足食,打造自己的vue文档生成工具与自己项目结合使…

前言 最近做的项目使用了微前端框架single-spa. 对于这类微前端框架而言,通常有个utility应用,也就是公共应用,里面是各个子应用之间可以共用的一些公共组件或者方法. 对于一个团队而言,项目中公共组件和方法的使用难点不在于封装不在于技术,很多时候在于团队内部成员是否都能了解这些组件,以避免重复开发,从而提升团队效率. 如果是团队比较小,人员比较稳定的项目组可能还好点,对于团队比较大,人员流动较快的团队,这些通用组件和方法往往就被人遗忘在角落,很难再得到有效利用. 因为我所在的项目还在…

关于Swaggo 或许你使用过Swagger, 而 swaggo就是代替了你手动编写yaml的部分.只要通过一个命令就可以将注释转换成文档,这让我们可以更加专注于代码. 目前swaggo主要实现了swagger 2.0 的以下部分功能: 基本结构(Basic Structure) API 地址与基本路径(API Host and Base Path) 路径与操作 (Paths and Operations) 参数描述(Describing Parameters) 请求参数描述(Describin…

#关于Swaggo 相信很多程序猿和我一样不喜欢写API文档.写代码多舒服,写文档不仅要花费大量的时间,有时候还不能做到面面具全.但API文档是必不可少的,相信其重要性就不用我说了,一份含糊的文档甚至能让前后端人员打起来. 而今天这篇博客介绍的swaggo就是让你只需要专注于代码就可以生成完美API文档的工具.废话说的有点多,我们直接看文章. 或许你使用过Swagger, 而 swaggo就是代替了你手动编写yaml的部分.只要通过一个命令就可以将注释转换成文档,这让我们可以更加专注于代码. 目…

1.添加Swagger2依赖 在pom.xml中加入Swagger2的依赖 <!--swagger2--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version> </dependency> <dependency>…

上一篇博客中,讲到了将WebApi Host到控制台和IIS,本篇总结一下如何将WebApi的Service以插件的形式进行动态部署,并设置Hoster的首页显示Api帮助文档,当然,也包括动态部署进来的插件的Api帮助. 话不多说,上酸菜,啊不, 上干货. 源码地址 建立Host 新建 Asp.Net Web Application, 解决方案名称填写WeiApiPluginDemo,项目名称填写IISHost,确定 选择 Empty, 确定 菜单中点选 Tools -> NuGet Pack…

暂时没学会正规的转载style临时记录一下 NET中的规范标准注释(一) -- XML注释标签讲解 http://www.cnblogs.com/mq0036/p/3544264.html NET中的规范标准注释(二) -- 创建帮助文档入门篇 http://www.cnblogs.com/mq0036/p/3544268.html 简言之: 1. 设置build参数,使XML可以生成在独立于代码的xml文件中. 2. 代码开发过程中养成添加备注的好习惯.VisualStudio中方法或类前输入…