前端开发过程中如何写文档注释

最新推荐文章于 2024-12-21 17:58:23 发布
原创 最新推荐文章于 2024-12-21 17:58:23 发布 · 2.5k 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#注释

本文介绍了如何使用JSDoc为JavaScript代码编写清晰、规范的注释，包括使用@deprecated标记废弃函数的方法，以及如何通过VSCODE快速生成JSDoc注释。

要学会用jsdoc

1：当你要注释一个函数时，就是不用这个函数了，或者函数版本低了，就需要用到@deprecated

2：一般比如打开 lodash 文档官网，查看一个api，然后打开source，可以看到源代码的和注释，那个注释就是用jsdoc然后生成这个可见的文档页面的。

3：采用VSCODE开发时，写完一个函数后，如果复杂的函数最好写个注释，快捷键是 输入/** 然后按回车键即可自动显示params参数列表

前端文件注释和方法注释总结
棠樾的博客
03-25 1511
文件注释： 文件头部增加文件注释，用于描述文件的基本信息。便于阅读代码时，快速的理解该文件的功能。 主要包含以下字段： @description 文件描述 @author 作者 @date 创建时间 @lastModifiedBy 最新的变更人 @lastModifiedTime 最新的更新时间 /** * @description 文件干啥用的 * @author Morning * @date 2022-03-25 16:16:52 * @lastModifiedBy Morni
前端开发文档平台搭建
云之彼端的博客
03-28 718
一定要做好技术选型，好的技术方案可以减少很多额外的开发工作。在做公共组件开发或框架设计的时候，要具备灵活性，减少后期的维护工作。一个好的组件不光是组件本身，简单易懂的说明文档也必不可少。众人拾柴火焰高，丰富前端开发文档平台需要大家一起努力。自动发布可视化文档编写。
前端注释总结
qq_32482743的博客
04-29 3128
目录 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普通注释 --> 特点：浏览器在页面...
前端开发流程
03-13
前端开发规范
前端—文档注释
CSSAJBQ_的博客
11-25 2323
方法参数注释：安装插件koroFileHeader。
关于前端开发的20篇文档与指南
BEST的专栏
03-01 764
相信在2015年很多这个行业的人都会有这样的两种感受： 真的不知所措，这个行业到底有多少东西需要去学习；渴望更多，并迫不及待的为接下来的学习寻求一些思想方向。 第一个来自于我们的个人感受，而第二个则是纯粹的必要性了。所以本文整理一些有用的信息，希望可以帮助相关领域的前端开发人员。 1. I want to use 基于Can I use的数据和功能，这款应用给予你选择一组前
精选资源
阿里前端开发规范《word文档》
04-08
- 开发过程中持续集成，及时发现并修复问题。 8. **代码复用与设计模式**： - 鼓励使用高阶函数、工厂函数和模块化设计减少重复代码。 - 合理应用面向对象设计原则，如单一职责、开闭原则等。 - 适当运用设计...
阿里前端开发规范word文档
04-02
阿里前端开发规范旨在提供一套完整的前端工程师在项目开发过程中应当遵循的规则和标准，以确保代码质量、提高团队协作效率并降低维护成本。这套规范涵盖了命名规则、编码风格、注释规范、错误处理、模块化、性能优化...
前端开发人员如何做好一份电子文档
最新发布
geng1025的博客
12-21 1080
制作高质量的电子文档是前端开发人员必备的技能之一。通过明确文档目的与受众、设计清晰合理的结构、编写简洁明了的内容、遵循格式规范、选择合适的工具与平台、注重文档的可维护性以及持续迭代与优化，前端开发人员可以不断提升自己的文档编写能力，为项目的成功实施和团队协作提供有力支持。同时，通过案例分享和最佳实践总结，读者可以更加深入地理解文档制作的技巧和要点，为实际工作提供有益的参考和借鉴。
精选资源
WEB前端开发规范文档.docx
11-22
虽然文档未详细列出，但开发过程中应使用版本控制工具（如Git），代码检查工具（如ESLint），自动化构建工具（如Webpack），以及性能分析工具（如Chrome DevTools）等，以提升开发效率和代码质量。 **其他规范** 1...
精选资源
Vue前端开发规范.pdf
10-29
在前端开发过程中，遵循规范是至关重要的。它不仅影响代码的维护和理解成本，而且在团队协作中至关重要。规范的目的是统一团队的代码风格，提高代码的可读性和降低维护成本。尽管规范并不总是有最优解，但团队成员...
＜前端＞前端注释规范
如风逝去
11-20 3333
注释在代码编写过程中的重要性，写代码超过半年的就能深深的体会到。没有注释的代码都不是好代码。为了别人学习，同时为了自己以后对代码进行‘升级’，看看js/javascript代码注释规范与示例。来自：http://www.56.com/style/-doc-/v1/tpl/js_dev_spec/spec-comment.html 文件注释 文件注释位于文件的最前面，应包括文件的以下信息：概要说明及版本（必须）项目地址（开源组件必须）版权声明（必须）开源协议（开源组件必须）版本号（必须）修改时间（必须..
前端：HTML、CSS、JavaScript 代码注释 / 注释与代码规范
热门推荐
snow的博客
06-25 1万+
HTML注释是在HTML代码中添加说明和解释的一种方法，这些注释不会被浏览器渲染或显示在页面上，而是被浏览器忽略。使用单行注释或多行注释：对于较短的注释，可以使用单行注释；对于较长的注释或需要跨越多行的注释，应使用多行注释。使用有意义的注释：确保注释提供了有价值的信息，而不是简单的“TODO”或“此处需要修改”。结束来标记多行注释。位于被注释的代码附近：通常，注释应位于被注释的代码之前或之上，以便于阅读和理解。位于被注释的代码之前：通常，注释应位于被注释的代码之前，以便于阅读和理解。
前端开发文档
a1031601764的博客
04-16 3272
基本规则： 符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度. 文件规范： 1.html, css, js, images文件均归档至<系统开发规范>约定的目录中如（public）; 2. html文件命名: 英文命名, 后缀.htm. 同时将对应界面稿放于同目录中, 若界面稿命名...
html+文件注释规范,前端注释规范.doc
weixin_39657662的博客
06-21 223
前端注释规范前端注释规范篇一：Web前端开发规范手册Web前端开发规范手册一、规范目的1.1 概述 ..................................................................................................................................... 1二、文件规范2.1 文件命名...
前端规范 - 前端注释规范
loulanyijian的专栏
06-20 2736
最近做的项目，因为看别人的代码，没有注释，看的简直头疼。 代码注释，是一个程序员最基本的素养，因为写的代码，不只是给机器去执行的，还需要给自己看，给继任者看，给同项目小伙伴看注释是一个磨刀不误砍柴工的活，自己阅读起来会快；大家都写注释，互相了解起来方便 如果真的开发任务很重，可以把握优先级，把核心的注释写好有的同事，觉得自己命名没问题，逻辑没问题，就可以不用写注释 这样的好习惯，的确可以少些一部分注释，不过所以没有理由不写注释，注释写的好，不见得是好程序员；注释写不好，肯定不是好程序员！单vue文件、js文
前端注释规范
m0_54829066的博客
08-20 681
遵循这些命名规范可以使你的前端代码更加清晰、易读、可维护，并且有助于团队协作和项目的长期发展。同时，不同的团队或项目可能会有一些特定的命名规范要求，你可以根据实际情况进行调整和适应。遵循这些注释规范可以使你的前端代码更加易于理解和维护，提高团队协作的效率。同时，不同的项目或团队可能会有一些特定的注释要求，可以根据实际情况进行调整和适应。在前端开发中，遵循良好的命名规范可以提高代码的可读性、可维护性和团队协作效率。在前端开发中，良好的注释规范可以提高代码的可读性和可维护性。
前端入门程序及注释
qiang1120131005的博客
01-03 606
前端框架入门程序及示例
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值