Vue JsDoc Vue.js 的文档注释使用的是基于 JSDoc 的风格,但是添加了Vue.js 特有的运行时和模板相关的标签。 1.@prop @prop {type} propName - 用于描述组件的属性列表(props),其中 type 是指属性数据类型,propName 是指属性名称。 代码语言:javascript 代码运行次数:0 运行 AI代码解释 /** * Button 组...
@type,进行基本类型注释。 // TypeScriptletname:string='Amy';// JSDoc/** @type {string} */letname='Amy'; Copy Vue JsDoc Vue.js 的文档注释使用的是基于 JSDoc 的风格,但是添加了Vue.js 特有的运行时和模板相关的标签。 1.@prop @prop {type} propName - 用于描述组件的属性列表(props),其中...
$ npm install --save-dev @vue/compiler-sfc Usage Your should update your JSDoc configuration to enable JSDoc-VueJS: {"plugins": ["node_modules/jsdoc-vuejs"],"source": {"includePattern":"\\.(vue|js)$"} } Update your .vue files with one of the following tags: ...
Vue JsDoc Vue.js 的文档注释使用的是基于 JSDoc 的风格,但是添加了Vue.js 特有的运行时和模板相关的标签。 1.@prop @prop {type} propName - 用于描述组件的属性列表(props),其中 type 是指属性数据类型,propName 是指属性名称。 /** * Button 组件 * * @prop {Boolean} disabled 是否禁用 * @prop...
Vue 使用 jsdoc 生成 JavaScript 文档 一、安装 jsdoc npm install --save-dev jsdoc 二、配置 jsdoc.json {"source": {"include": ["src/"],"exclude": ["src/router"] },"opts": {"template":"node_modules/docdash","encoding":"utf8","destination":"./docs/","recurse":true,"verbose":...
以下是一个简单的Vue组件的JSDoc注释示例: ```js / * @description 组件名称 * @component 组件类型 * @version 版本号 * @param {String} [propName=defaultValue] - 组件的属性名和默认值 * @returns {Object} - 返回组件实例对象 * @events {eventName} - 组件触发的事件名 */ export default { ...
JSDoc:JSDoc是一种根据JavaScript代码中的注释生成API文档的工具。它也可以用来为JavaScript代码提供类型信息,但这种类型信息主要用于文档生成和IDE的智能提示,不会在运行时或编译时进行类型检查。 TypeScript:TypeScript是JavaScript的一个超集,它添加了可选的静态类型、类、接口和模块等特性。TypeScript在编译时执行类型...
Vue 官方周报 #124 - 使用JSDoc记录组件属性 Hi 👋 当你将鼠标悬停在IDE中的组件上时,显示组件属性所对应的描述,这个功能在开发过程中会很有用。你可以在传递给defineProps函数的TypeScript接口中使用JSDoc来实现这一点: MyComponent.vue exportinterfaceProps{/** The name of the user. */name:string/*...
在 Nodejs 中使用 docvue 为一个函数,接受2个参数,第一个为源码字符串,第二个为选项对象,返回...
JSDoc vue-jsdoc vscode __EOF__ --- 生活的意义就是你自己知道你要做什么,明确目标。没有目标,后面都是瞎扯! https://pengchenggang.gitee.io/navigator/ SMART原则: 目标必须是具体的(Specific) 目标必须是可以衡量的(Measurable) 目标必须是可以达到的(Attainable)...