前端注释

最新推荐文章于 2025-04-24 20:08:17 发布
最新推荐文章于 2025-04-24 20:08:17 发布
阅读量615 收藏 1
点赞数 3
CC 4.0 BY-SA版权
分类专栏： js 文章标签： 前端注释
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/Chenming_321/article/details/97769383

不知道在做前端的各位对于写注释是什么样的一个想法；先说说我的想法；
当时在写一个项目是后台管理系统的时候，我就特别少写注释；那时我觉得这个代码很简单啊，为什么要写注释，浪费时间；不用写一会回来看看一定会明白的；
所以代码是这样的： 看图

在这里插入图片描述

一千的逻辑几乎没有一个注释；
于是过了一个月两个月回来修改bug修改需求时；
凉凉；我当时为什么这么写？这个是干嘛？啊？业务逻辑好多啊？又得花时间理清楚；

后来的我是这样紫的：

在这里插入图片描述

全都是泡沫！！！
全都是注释；我连什么需求都要写上去了；
所以啊。想告诉大家一定要写注释啊。不然痛苦的还是自己；不写就跑路咯。让下一个大佬接你的~

到这里了给大家一个看一个段子；
在这里插入图片描述
我在想我要写的好还是不好呢？好纠结啊这么这么难的；？？？？？

前端实战之HTML、CSS 常用标签注释
Burgess_zheng的博客
01-14 891
上一篇：前端初识(三把利器：HTML标签、CSS、JS(javascript)) 点击跳转 目录篇：前端(html,css,js)目录篇 点击跳转 下一篇：前端三把利器之HTML总结 点击跳转   <!DOCTYPE html><!--该html格式默认的类型是!DOCTYPE（公共统一认可的html规范类型）--> <html lang="en">&lt...
前端文件注释和方法注释总结
棠樾的博客
03-25 1451
文件注释： 文件头部增加文件注释，用于描述文件的基本信息。便于阅读代码时，快速的理解该文件的功能。 主要包含以下字段： @description 文件描述 @author 作者 @date 创建时间 @lastModifiedBy 最新的变更人 @lastModifiedTime 最新的更新时间 /** * @description 文件干啥用的 * @author Morning * @date 2022-03-25 16:16:52 * @lastModifiedBy Morni
前端代码规范 - 代码注释
南城
04-11 1781
良好的注释规范有助于提高代码质量，促进团队协作，加快新成员的项目熟悉速度，不仅能帮助自己和他人快速理解代码，还能提高代码的可维护性。
前端：HTML、CSS、JavaScript 代码注释 / 注释与代码规范
热门推荐
snow的博客
06-25 1万+
HTML注释是在HTML代码中添加说明和解释的一种方法，这些注释不会被浏览器渲染或显示在页面上，而是被浏览器忽略。使用单行注释或多行注释：对于较短的注释，可以使用单行注释；对于较长的注释或需要跨越多行的注释，应使用多行注释。使用有意义的注释：确保注释提供了有价值的信息，而不是简单的“TODO”或“此处需要修改”。结束来标记多行注释。位于被注释的代码附近：通常，注释应位于被注释的代码之前或之上，以便于阅读和理解。位于被注释的代码之前：通常，注释应位于被注释的代码之前，以便于阅读和理解。
前端如何优雅的注释？
weixin_55988085的博客
12-20 685
好的注释方便自己也方便他人
前端学习01-03注释与特殊字符
dieyuqi2955的博客
12-19 165
HTML文件使用<!--内容-->对内容进行注释 注释标签不能被嵌套使用 HTML文件中的特殊字符： &gt表示大于号 &lt表示小于号 &nbsp表示空格 &#169表示版权符号 &copy表示版权符号 &amp表示& &Reg表示圆圈R &qute表示引号 很多工具可以完成这些字...
pxcook前端注释工具
12-03
**PxCook前端注释工具详解** PxCook是一款强大的前端设计与开发辅助工具，它专为提升前端工程师的工作效率而设计。通过提供精确的像素测量、元素注释和颜色取样等功能，PxCook帮助开发者更好地实现设计稿与前端代码...
web前端开发——标签一（注释、标题、段落、换行、格式、图片）
b19839356939的博客
07-08 1666
web前端、标签、前端、注释标签、标题标签、段落标签、换行标签、格式标签、img标签、src属性
前端基础-CSS注释
01-20
在前端开发中，CSS（Cascading Style Sheets）是一种用于定义HTML或XML（包括SVG、MathML等各种XML方言）文档中元素样式的样式表语言。本文将深入探讨CSS中的注释语法以及基本选择器，这些都是编写高效且易于维护的...
前端领域TypeScript的代码注释规范与文档生成
最新发布
小白菜的博客
04-24 1151
在前端开发中，TypeScript 凭借其静态类型检查和面向对象编程的特性，极大地提高了代码的可维护性和可扩展性。然而，随着项目规模的不断扩大，代码的复杂度也日益增加。代码注释作为代码文档的重要组成部分，能够帮助开发者更好地理解代码的功能、设计意图和使用方法。本文章的目的在于为前端开发者提供一套完整的 TypeScript 代码注释规范，并介绍如何利用这些注释生成高质量的代码文档。范围涵盖了 TypeScript 代码中各种元素的注释方法，如类、接口、函数、变量等，以及常用的文档生成工具和使用方法。
前端注释规范
秋来九月八
07-29 1858
单行注释用// 单行注释，要单起一行，放在要注释代码的上方。如果单行注释不是代码块的首行，那么注释前面需要空出一行 注释前要带一个空格便于阅读 多行注释用/** …/和//… 多行注释/** …/用在文件说明，类型说明，参数说明 //…用在代码多行注释 //TODO : 来标记即将处理的问题 //FIXME: 来标记需要解决的问题 ...
前端注释总结
qq_32482743的博客
04-29 3094
目录 1.HTML注释 1.1普通注释 1.2条件注释 2.CSS注释 2.1css注释 3.JS注释 3.1单行注释 3.2多行注释 4.JSP注释 前端涉及到的文件类型比较多，目前先整理常见的HTML、CSS、JS、JSP中的注释。 1.HTML注释 1.1普通注释 HTML中的普通注释为：<!-- HTML普通注释 --> 特点：浏览器在页面...
前端注释方法
m0_65274248的博客
03-20 2866
前端注释方法
前端语言注释
qq_38183393的博客
02-20 380
HTML注释： <!--这是单行注释--> <!-- 这是多行注释 这是多行注释 这是多行注释 --> JS/jQuery注释： //这是单行注释 /* 这是多行注释 这是多行注释 这是多行注释 */ css注释： /*这是单行注释*/ /* 这是多行注释 这是多行注释 这是多行注释 */ ...
前端开发语言涉及到 的注解（Annotations）
2401_90032064的博客
01-01 1119
注解是一种元数据，它可以为程序的代码提供额外的信息。注解本身并不直接影响程序的逻辑行为，但它们可以被编译器、开发工具或运行时环境使用，以便生成代码、执行特定操作或者提供某种信息。在前端开发中，注解可以用于各种目的，例如类型检查、代码生成、文档生成等。注解作为一种增强代码表达力的有效工具，在前端开发中扮演了越来越重要的角色。它不仅提高了代码的可读性和可维护性，还为开发者提供了更强大的编程能力。通过合理利用注解，前端开发者可以在日常工作中提升效率，实现更快速、更精确的开发过程。
前端之TS类型注解、接口（vscode自编译ts→js）
weixin_46372074的博客
06-27 6517
1.命令行安装自动编译命令 2.修改配置中的输出js存储位置和关闭严格模式 3.启动监视，自动编译ts为js启动监视任务: 终端 -> 运行任务 -> 监视tsconfig.json 1.html： 2.ts： 3.自动编译的js 结果：
前端入门程序及注释
qiang1120131005的博客
01-03 567
前端框架入门程序及示例
前端—文档注释
CSSAJBQ_的博客
11-25 2159
方法参数注释：安装插件koroFileHeader。
VScode前端注释vue
03-12
### 在 VSCode 中为 Vue 项目编写前端注释的最佳实践 对于在 Visual Studio Code (VSCode) 中开发的 Vue 项目而言，良好的注释习惯能够显著提升代码可读性和维护效率。以下是针对 Vue 组件文件 `.vue` 的一些推荐做法： #### 单行注释 单行 JavaScript 注释 (`//`) 和多行注释 (`/* */`) 都可以在 `<script>` 标签内部用于解释逻辑复杂度较高的部分[^3]。 ```javascript <script> export default { name: 'ExampleComponent', data() { // 这里定义组件的状态变量 return {} }, } </script> ``` #### 多行注释模板 当涉及到函数或者方法时，可以采用 JSDoc 样式的多行注释来描述参数、返回值以及可能抛出异常的信息。这不仅有助于其他开发者理解功能实现，还能让编辑器提供更智能的帮助提示。 ```javascript <script> /** * 计算两个数之和. * * @param {number} a - 加数之一 * @param {number} b - 另一个加数 * @returns {number} 返回两数相加之和 */ function add(a, b){ return a + b; } export default { methods:{ add, } }; </script> ``` #### 使用 ESLint 插件强化规范 安装并配置 `eslint-plugin-vue` 后，在项目的根目录下创建或修改现有的 `.eslintrc.js` 文件加入如下规则以强制执行某些特定风格的注释要求[^2]: ```javascript module.exports = { extends: [ 'plugin:vue/recommended' ], rules: { 'vue/comment-directive': ['error', 'always'], ... } }; ``` #### HTML 结构内的注释 除了脚本区域外，在 `<template>` 或者 `<style scoped>` 节点之间也可以放置标准HTML形式(`<!-- -->`)的备注说明页面布局意图或是样式作用范围等信息[^1]. ```html <template> <!-- 主要展示区 --> <div class="main-content"> {{ message }} </div> <!-- 辅助操作栏 --> <aside v-if="showSidebar"></aside> </template> ``` 通过遵循上述指南，团队成员间能更好地交流协作；同时也有利于后期快速定位问题所在位置，减少不必要的沟通成本和技术债务积累。
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值