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

最新推荐文章于 2024-06-25 22:00:00 发布
最新推荐文章于 2024-06-25 22:00:00 发布
阅读量2.3k 收藏
点赞数
分类专栏： tips 文章标签： 注释
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/AndyNikolas/article/details/78910802
版权

要学会用jsdoc

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

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

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

杨不败
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
前端文件注释和方法注释总结
棠樾的博客
03-25 1288
文件注释： 文件头部增加文件注释，用于描述文件的基本信息。便于阅读代码时，快速的理解该文件的功能。 主要包含以下字段： @description 文件描述 @author 作者 @date 创建时间 @lastModifiedBy 最新的变更人 @lastModifiedTime 最新的更新时间 /** * @description 文件干啥用的 * @author Morning * @date 2022-03-25 16:16:52 * @lastModifiedBy Morni
前端开发【注释】
苏小姐的茶
03-15 412
前端开发 单行注释 多行注释
前端技术总结.docx
03-18
此文档是本人在使用前端开发技术的过程中总结的相关技术点，包括了vue，react，es6,ts,js等前端技术，在此分享给大家，希望有什么问题可以留言我会及时的进行更改，大家一起学习进步提升技术。谢谢
前端：HTML、CSS、JavaScript 代码注释 / 注释与代码规范
最新发布
snowball的博客
06-25 2806
HTML注释是在HTML代码中添加说明和解释的一种方法，这些注释不会被浏览器渲染或显示在页面上，而是被浏览器忽略。使用单行注释或多行注释：对于较短的注释，可以使用单行注释；对于较长的注释或需要跨越多行的注释，应使用多行注释。使用有意义的注释：确保注释提供了有价值的信息，而不是简单的“TODO”或“此处需要修改”。结束来标记多行注释。位于被注释的代码附近：通常，注释应位于被注释的代码之前或之上，以便于阅读和理解。位于被注释的代码之前：通常，注释应位于被注释的代码之前，以便于阅读和理解。
前端—文档注释
CSSAJBQ_的博客
11-25 946
方法参数注释：安装插件koroFileHeader。
使用MySQL语句给数据库的表和字段添加注释
学而时习
06-01 1万+
给MySQL语句添加注释 ​ MySQL中使用 “comment” 来给数据库表的字段或列添加注释的，以下是给表添加注释的集中情况： 一、给表添加注释 ​ 1）创建表时添加注释 CREATE TABLE table2 ( tname INT COMMENT 'tname字段的注释' ) COMMENT = 'table2表的注释'; ​ 2）创建表后添加注释 ALTER TABLE table2 COMMENT '修改表table2的注释'; 二、给字段添加注释 ​ 1）新建表时给表内字段添加注释 C
项目开发-接口开发API文档 常用的注解
weixin_44250329的博客
06-11 1437
DTO: @Data: 类注解，作用于实体类的setter和getter的生成，属于lombok插件中的注解 @ApiModel:类注解，作用于接口文档的实体类的描述 @ApiModelProperty:属性方法注解， Service: @Service: @Resource: Controller: @RestController： @RequestMapping: @Api: @Autowired: @ApiOperation: @GetMapping: @Api..
阿里前端开发规范《word文档》
04-08
- 开发过程中持续集成，及时发现并修复问题。 8. **代码复用与设计模式**： - 鼓励使用高阶函数、工厂函数和模块化设计减少重复代码。 - 合理应用面向对象设计原则，如单一职责、开闭原则等。 - 适当运用设计...
WEB前端开发规范文档.docx
11-22
虽然文档未详细列出，但开发过程中应使用版本控制工具（如Git），代码检查工具（如ESLint），自动化构建工具（如Webpack），以及性能分析工具（如Chrome DevTools）等，以提升开发效率和代码质量。 **其他规范** 1...
阿里前端开发规范word文档
04-02
阿里前端开发规范旨在提供一套完整的前端工程师在项目开发过程中应当遵循的规则和标准，以确保代码质量、提高团队协作效率并降低维护成本。这套规范涵盖了命名规则、编码风格、注释规范、错误处理、模块化、性能优化...
阿里前端开发规范.pdf
04-17
在编写阿里前端开发规范文档的过程中，涉及到了前端开发的多个重要方面，包括编程规约、HTML规范、CSS规范、LESS规范、Javascript规范以及Vue项目规范。以下是这些规范的详细知识点： 一、编程规约 命名规范是编程...
Vue前端开发规范.pdf
10-29
在前端开发过程中，遵循规范是至关重要的。它不仅影响代码的维护和理解成本，而且在团队协作中至关重要。规范的目的是统一团队的代码风格，提高代码的可读性和降低维护成本。尽管规范并不总是有最优解，但团队成员...
后端接收前端数据的三种注解方式
weixin_44414474的博客
05-24 8562
第一种：@RequestParam注解 一、作用： 将指定的请求参数赋值给方法中的形参。 二、接收形式： Get传参请求。 三、属性： （1）value ：绑定请求的参数名，默认绑定为同名的形参； （2）required：是否必须，默认是true，表示请求中一定要有相应的参数，否则将报错； （3）defaultValue：默认值，表示如果请求中没有接收到值时的默认值。 四、用法示例： @GetMapping("/test") public void test(@RequestParam(requir
＜前端＞前端注释规范
如风逝去
11-20 3147
注释在代码编写过程中的重要性，写代码超过半年的就能深深的体会到。没有注释的代码都不是好代码。为了别人学习，同时为了自己以后对代码进行‘升级’，看看js/javascript代码注释规范与示例。来自：http://www.56.com/style/-doc-/v1/tpl/js_dev_spec/spec-comment.html 文件注释 文件注释位于文件的最前面，应包括文件的以下信息：概要说明及版本（必须）项目地址（开源组件必须）版权声明（必须）开源协议（开源组件必须）版本号（必须）修改时间（必须..
前端注释方法
m0_65274248的博客
03-20 2750
前端注释方法
前端注释工具的优雅使用指南
alexsaurora的博客
07-30 1750
对于代码来说，注释是一个可以帮助我们快速理解代码含义、用法的好工具，今天我们就来盘一盘前端可以使用的优雅注释工具。
如何写前端技术方案文档?
热门推荐
程序员成长指北
12-25 1万+
大厂技术高级前端Node进阶点击上方程序员成长指北，关注公众号回复1，加入高级Node交流群前言百度百科对计算机软件的的定义为：“计算机软件( Software，也称软件)是指计...
前端技术文档编写思路
idanzk的博客
03-11 835
前端技术调研文档和概要设计文档总结
技术文档（3）前端开发—vue项目—规范文档
dugujiuding的博客
03-31 1万+
前端开发—vue项目—规范文档
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值