在过去,我通常单独使用jsdoc。但这次,我想做一个不同的尝试,使用TS类型定义和jsdoc协作。 我们只需在项目根目录创建一个jsconfig.json文件即可,基本配置如下。我们的项目中使用了element-plus组件库,为了提供更好的智能感知,我添加了element-plus的TS类型定义到compilerOptions的types数组。 复制
使用JavaScript的类型注解 如果你在使用JavaScript,可以通过JSDoc注释来提供类型信息: 代码语言:txt 复制 /** * @typedef {Object} User * @property {string} name - The user's name. * @property {number} age - The user's age. */ /** * @type {Object} * @property {User} user - The use...
虽然类型注释在 TypeScript 文件中得到了最广泛的应用,但在 Vue 3 项目中,即便是在非 TypeScript 文件(如 .js 文件)中,也可以通过其他方式使用类型注释。例如,可以使用 JSDoc(JavaScript Documentation)注释来为 JavaScript 代码提供类型信息。 4. 提供示例 在Vue 3 项目中,如果你希望在 JavaScript 文件中使用类型...
//路径:src\utils\index.ts/** * JSDoc注释 隐藏用户手机号码 *@parammobile 手机号码 *@returns处理后的手机号码如 : 123***1123 */exportconsthiddenMobileNumber= (mobile: string) => {// 字符串截取// return mobile.slice(0, 3) + '***' + mobile.slice(-4);// 字符串正则替换,\d 表示数...
"valid-jsdoc": 0,//jsdoc规则 "valid-typeof": 2,//必须使用合法的typeof的值 "vars-on-top": 2,//var必须放在作用域顶部 "wrap-iife": [2, "inside"],//立即执行函数表达式的小括号风格 "wrap-regex": 0,//正则表达式字面量用小括号包起来 ...
export const useStore = defineStore('main', { state: () => ({ count: 0, }), getters: { // 类型是自动推断出来的，因为我们没有使用 `this` doubleCount: (state) => state.count * 2, // 这里我们需要自己添加类型(在 JS 中使用 JSDoc) // 可以用 this 来引用 gett...
功能开发时编写的相关方法要进行方法注释和说明,注释要遵循JSDOC规范。 方法注释格式: /** * @description: 方法描述 (可以不带@description) * @param {参数类型} 参数名称 * @param {参数类型} 参数名称 * @return 没有返回信息写 void / 有返回信息 {返回类型} 描述信息 ...
一、编译时优化：类型驱动开发范式 1.1 类型系统深度集成 在复杂业务系统中， Props类型校验和组合式API的类型推导是核心痛点，同时完整的组件契约需要包含Props和 Events的类型声明。通过Vue3.3+的宏系统实现编译时类型安全：类型安全增强策略：1. 使用 defineEmits声明组件事件类型 2. 通过JSDoc注释增强类型文档 3....
另外使用 jsDoc 进行参数说明,有的时候是可以出现提示,就算不出提示,也是可以有说明的作用,避免过几天自己都想不起来怎么用参数了。 挂载事务 拿到数据库的连接对象之后,我们可以(必须)开启一个事务,然后才能执行其他操作。 所以我们需要先把事务封装一下,那么为啥要单独封装事务呢?
通过读取types.ts文件内 jsDoc 注释信息, 自动渲染为 md-table, 如enumobjectFunction等复杂形式, 结合vp-api-typing(基于 PxTooltip组件)实现类似 element-plus markdown-tooltip 的表现形式 interface ButtonProps { /** * @property type * @type enum - primary | success | warning | danger | base ...