JS TS 给函数注释的规范

前言：使用这种注释方法，在其他地方调用这个函数，鼠标停在这个函数上面时，就是显示这些注释，是一种十分必要的规范。

使用 Alt + Shift + A 可以快速生成 /**/ ,最好是自己配置 Snippet

效果：

例子：

/*** @describe 判断时候是闰年* @param year 年份* @returns 是或者否*/
export function isLeapYear(year: number): boolean {return (year % 4 === 0 && year % 100 !== 0) || year % 400 === 0;
}/*** @describe 获取距离某个时间点相差的天数* @param date 目标日期* @param start 开始日期* @returns 天数*/
export function getDays(date: Date, start?: Date): number {const year = date.getFullYear();const month = date.getMonth() + 1;const day = date.getDate();let days = day;const monthDays = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31];for (let i = 0; i < month - 1; i += 1) {days += monthDays[i];}// 如果是闰年,天数加一if (isLeapYear(year) && month > 2) {days += 1;}if (start) {return days - getDays(start);}return days;
}

JS TS 给函数注释的规范相关推荐

函数注释规范_Go语言编码规范
本规范旨在为日常Go项目开发提供一个代码的规范指导,方便团队形成一个统一的代码风格,提高代码的可读性,规范性和统一性.本规范将从命名规范,注释规范,代码风格和 Go 语言提供的常用的工具这几个方面做一 ...
函数注释规范_C++掌握标准编码规范，摘掉初级“码农”帽子！
代码千万条,可读第一条. 编码不规范,error多两行. 由此可见,编码规范可谓是各位预备程序员的开学第一课呀. 为了帮助初学的小伙伴更好地规范自己的代码,介于之前发了C语言版,今天就整理了一篇C++ ...
C++编程规范头文件格式和函数注释格式
C++编码规范(1):代码注释当你阅读别人的代码时如果没有注释那会是件比较痛苦的事.一说到注释我们马上想到是通过//或/* */这样来添加一些描述信息.这只是狭义的注释. 广义的注释我们可以理解为, ...
php 注释函数参数样例,PHP函数注释规范 - YangJunwei
码农一般都处于频繁Coding中,回过头再看自己2月前写的函数,估计也头大...因此,在此分享一些常用的函数注释标签及说明,建议大家尽量用吧! /** * @name 名字 * @abstract 申 ...
js时间格式化函数，支持Unix时间戳
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/ ...
JS OOP -02 深入认识JS中的函数
深入认识JS中的函数: 1.概述,认识函数对象 2.函数对象和其他内部对象的关系 3.将函数作为参数传递 4.传递给函数的隐含参数:arguments 5.函数的apply,call方法和length ...
c++ _int64转字符串_C语言仿JS的eval函数解析字符串
C语言利用后缀表达式解析字符串(符合c98标准,很容易移植到计算器上) 最近用98标准的C语言写了个解析字符串,类似于JavaScript中的eval函数,感觉挺实用(移植到了计算器上,可以画F(X ...
《C语言深度解剖》中的.c/.h 程序模板及函数注释风格
编程规范和变量命令规范对于代码的可阅读性.可维护性有着很大的影响.编程规范有很多,大公司也会制定自己公司的编程规范,如<华为技术有限公司c语言编程规范>等.对于个人编程来说没必要将自己编写 ...
为啥JS/TS里都会有“use strict“
本文分享自华为云社区<JS/TS里的"use strict"严格模式是什么?>,作者: gentle_zhou. 在日常JS/TS项目开发过程中,经常会在文件开头看到& ...

JS TS 给函数注释的规范

JS TS 给函数注释的规范相关推荐

最新文章

热门文章