vue文件 注释规范

最新推荐文章于 2024-01-15 09:39:02 发布
最新推荐文章于 2024-01-15 09:39:02 发布
阅读量1.8k 收藏 2
点赞数
分类专栏： Vue 问题解决\功能实例 文章标签： vue
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/AN_MEI/article/details/106213307
版权
本文详细介绍了Vue.js开发中文件和代码的注释规范，包括组件、模板、脚本和样式部分的注释标准，旨在提升代码可读性和团队协作效率。
摘要由CSDN通过智能技术生成 
<!--
 * @Descripttion: (对该文件的信息描述)
 * @version: (版本)
 * @Author: (作者)
 * @Date: (文件创建时间)
 * @LastEditors:
最低0.47元/天 解锁文章
<李小狮 / >
关注
专栏目录
vue项目代码注释规范
静水流深
02-20 3万+
文件注释规范 ​ 单个文件注释规范，每个独立的VUE文件开头都要进行注释，表明该文件的描述信息、作者、创建时间等。 <!-- * @FileDescription: 该文件的描述信息 * @Author: 作者信息 * @Date: 文件创建时间 * @LastEditors: 最后更新作者 * @LastEditTime: 最后更新时间 --> 效果： 方法注释规范 ...
VUE代码注释规范，代码规范
qlin_11的博客
08-15 3196
VUE代码注释规范，代码规范 背景 其实关于这一点我是深恶痛绝呀，你说我们吧eslint开了，来敲代码，就能把你的代码给规范了吧，关于组件命名和src结构都是按照VUE目录给的(项目成员已构造)，功能注释和调试代码（模拟数据的部分，已注释，用于和客户方展示，判定好才可删除）和后期需求优化的地方注释。 开发过程上到svn是不是要每日update和晚上commit来管理代码呢，当然是。可是当我把这部分...
【Vue】 前端代码风格指南--注释规范
DomCode
07-09 5749
如无必要，勿增注释 ( As short as possible ) 如有必要，尽量详尽 ( As long as necessary )
vue中设置注释模板
最新发布
Webgiser_yy的博客
01-15 1129
【代码】vue中设置注释模板。
/** 内容 */、vue文件头部注释
weixin_39418338的博客
08-26 1602
1、/** 内容 */ 一直想知道这注释怎么做到的，今天查阅资料，原来是这么回事 在没有输入注释内容的情况下，输入/** 会自动 /** */中间输入注释的内容，换行会自动在前面带星 /** *open:true浏览器是否自动打开，不写默认false，true自动打开 */ 2、vscode在插件中查询插件koroFileHeader安装 (1)文件-》首选项-》设置 搜索fileheader (2)、在settings.json配置内容 "filehead...
Vue前端开发规范.pdf
10-29
以上是从提供的文件内容中提炼的Vue前端开发规范的核心知识点，涉及编码风格、命名规则、文件结构、代码组织、周期钩子、HTML和CSS以及JavaScript的具体实践。这些规范帮助提高代码的可读性、维护性并降低团队协作...
Vue前端编码规范.pdf
03-05
本文将详细介绍Vue前端项目的编码规范，包括命名规范、文件结构、变量定义、函数声明以及注释规范等内容。 #### 二、命名规范 **1. 驼峰式命名法** - **PascalCase（大驼峰命名法）**：适用于类名或组件名称等，...
vue项目规范文档
01-17
注释规范 - 方法顶部必须添加注释。 - HTML中功能区域起始和结束位置添加注释。 - CSS中重要的功能区域添加注释。 - 对于复杂逻辑、特殊变量处理等情况添加详细注释。 通过以上规范的实施，可以有效地提升Vue项目...
【前端学习记录】Vue前端规范整理
Note_creek的博客
12-11 1583
前端规范
Vue项目 注释模板
weixin_30338481的博客
04-16 1460
此内容只适用于vscode 1.打开项目-》按快捷键-》ctrl+shift+p 2.选择红线选中的内容 ，如果是中文版看如下图片 如果是英文版看如下图 3.就开始进行配置 大家根据这张图来配置内容 在输入框中输入css点击回车，然后会进入css.json 的文件 { "Print to cssTitle": { "prefix": "...
Vue项目书写规范
weixin_44090040的博客
08-20 3924
1. 组件名为多个单词 我们开发过程中自定义的组件的名称需要为多个单词，这样做可以避免跟现有的以及未来的HTML元素相冲突，因为所有的 HTML 元素名称都是单个单词的。 推荐： Vue.component('todo-item', { // ... }) export default { name: 'TodoItem', // ... } 不推荐： Vue.component('todo', { // ... }) export default { name: 'Todo',
函数式注释、文件头部注释
锡城小凯的博客
07-20 927
标准函数式注释 /** * @method 方法名 * @for 所属类名 * @param{参数类型}参数名 参数说明 * @return {返回值类型} 返回值说明 */ 文件头部注释 /** * @Description: 描述 * @Author: 作者名 * @Date: 创建日期 * @LastEditTime: 最新修改日期 * @LastEditors: 最新修改者 */ 常用参数 //具体可以看下面的链接 /** * @class * @ca.
Vue 前端代码风格指南
Mr.小灰狼_随笔
08-17 5363
Vue 前端代码风格指南 代码规范是一个非常重要的事情 ，很多企业都有自己的代码规范体系 ，而在不同阶段体系 HTML 、CSS、JS 也有代码规范 ! 那么到了后期框架和库阶段规范你知道吗 ? 今天为大家分享一组热门框架 VUE 的代码风格规范指南 ， 希望后续在写 Vue 方面代码有所帮助 ! 目录 一、命名规范 1.1、项目文件命名 1.2、Vue 组件命名 1.3、代码参数命名 二、代码规范 2.1、Vue 2.2、HTML 2.3、CSS 2.4、JavaScript 三、注释规范 四、其它...
Vue学习(2)指令
Sqssq的博客
03-30 237
<!-- * @Author: your name * @Date: 2020-02-01 11:19:29 * @LastEditTime: 2020-03-30 21:32:11 * @LastEditors: Please set LastEditors * @Description: In User Settings Edit * @FilePath: \x\vue-or...
Eclipse中设置自动生成的author，date等注释
weixin_40873693的博客
08-14 800
在原有基础上添加即可 添加代码： /* * @author Dylan * @date ${date} ${time} * @version 1.0 */ Windows->preferences->java->code style->code templates->commedts->types 新增一个注解 Windows->preferences->java->code style->code templates-&
vue学习笔记
yshir
08-14 693
输入上面命令后，会询问几个选项，根据自己需要填写就可以了。 一、Project name :项目名称，如果不需要就直接回车。注：此处项目名不能使用大写。 二、Project description:项目描述，直接回车 三、Author ：作者 四、vue build 构建方式（暂且这么解释） 　　两个选择（上下箭头选择，回车即为选定）(是使用阉割版的vue还是使用完整版的vue 第一个是完整版的...
vscode 高效率开发插件一（代码注释）
热门推荐
安海军
03-22 4万+
1、添加文件头、函数注释（文件类型无限制） 插件名：koroFileHeader 配置项: setting中搜索：FileHeader // 头部注释,默认设置：{'Author':'your name','Date':'Do not edit','LastEditors':'your name','LastEditTime':'Do not edit','Description':'file...
vue规范 目录 注释 命名
07-31
在开发Vue项目时，遵循一定的规范能够提高代码的可维护性和可读性。 首先，目录结构应该清晰明了。一般来说，Vue项目的目录结构可以按照功能或者模块来组织。通常包含的目录有：src（源代码目录）、assets（静态资源目录）、components（组件目录）、views（视图目录）、router（路由目录）等等。通过合理的组织目录，能够使开发者更容易理解和查找代码文件。 其次，注释是必不可少的。在代码中添加适当的注释，可以帮助其他开发者更好地理解代码的功能和意图。注释应该写清楚代码的作用、实现思路以及可能的注意事项等等，以便于后续维护和团队合作。 最后，命名也是非常重要的。变量、函数、组件、类等的命名应该具有一定的规范和语义化，以便于代码的理解和维护。命名应该简洁明了，尽量避免使用过于复杂和容易产生歧义的命名方式。可以参考编程规范和最佳实践，如使用驼峰命名法、使用有意义的名词等等。 总之，遵循Vue规范的目录结构、添加适当的注释以及规范命名，可以提高代码的可读性和可维护性，有助于开发者更好地理解和使用代码。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值