JS 中怎么用注释(如 /*#**PURE***/)标记纯函数表达式帮助打包工具进行 Tree Shaking

夜涛酱_1171

夜涛酱_1171

2026-10-23

206人浏览

原创

/*#__pure__*/是用于标记无副作用函数调用的注释,告诉打包工具可安全移除未使用返回值的调用,需紧邻调用前、不可换行,仅适用于调用表达式而非声明。

js 中怎么用注释(如 /*#**pure***/)标记纯函数表达式帮助打包工具进行 tree shaking

在 JavaScript 中,可以通过特殊注释 /*#__PURE__*/(注意是两个下划线,不是三个)标记函数调用或表达式,向打包工具(如 Webpack、Rollup、Terser)表明该调用“无副作用”,可安全移除——这是辅助 Tree Shaking 的关键手段之一。

什么是 /*#__PURE__*/ 注释

这是一个被广泛支持的“纯函数调用”提示注释,写在函数调用前(紧邻,中间不能换行或空语句),告诉压缩器:“这个调用不产生副作用,其返回值若未被使用,整个调用可以被删除”。它本身不是 JS 语法,而是打包/压缩工具识别的约定标记。

⚠️ 注意:/*#**PURE***/ 是错误写法(多了一个 #,且星号数量/位置不对),正确形式只有:/*#__PURE__*/

怎么正确使用 /*#__PURE__*/

它必须直接放在函数调用表达式前面,且不能跨行。常见有效写法:

  • /*#__PURE__*/ foo(); ✅(调用无副作用,且返回值未被使用)
  • const x = /*#__PURE__*/ bar(1, 2); ✅(调用被标记,但返回值被使用 → 不会被删;标记仍有助于分析依赖)
  • /*#__PURE__*/ (function(){ ... })(); ✅(立即执行函数,明确声明无副作用)
  • /*#__PURE__*/ myObj.method(); ✅(方法调用也可标记)

❌ 错误用法:

  • /*#__PURE__*/ function foo() {} —— 标记函数声明无效(PURE 只作用于调用)
  • /*#__PURE__*/
    foo();
    —— 换行导致解析失败
  • foo(/*#__PURE__*/ 42); —— 放在参数里无意义

配合纯函数导出提升 Tree Shaking 效果

仅加 /*#__PURE__*/ 不足以让未使用的导出函数被摇掉。真正起作用的是:模块级静态分析 + 无副作用的导出 + 工具链支持。你可以这样增强效果:

chartjs-reporter
chartjs-reporter

此技能用于在用户需要将结构化数据(查询结果、CSV 摘要、JSON 记录或 Python 字典/列表)转换为独立的 HTML 页面时使用。

下载
  • 确保导出的函数确实是纯的(不读写全局、不操作 DOM、不发起请求、不修改入参)
  • 用 ES Module 导出(export const utils = { fn: () => 42 }; 不如 export function fn() { return 42; } 易于分析)
  • 在构建配置中启用 sideEffects: false(package.json)或显式声明副作用文件
  • 对已知纯的第三方调用加标记,例如:/*#__PURE__*/ lodash.noop();,帮助 Terser 在压缩阶段剔除未使用的链式调用

实际例子:让工具识别并移除未使用的纯计算

假设你有工具函数:

utils.js

export function add(a, b) { return a + b; }<br>
export function log(msg) { console.log(msg); } // 有副作用

在入口中:

index.js

import { add, log } from './utils.js';<br>
/*#__PURE__*/ add(1, 2); // 返回值丢弃,且标记为 PURE<br>
log('start');

开启生产构建后,Terser 或 Webpack 可能完全移除 /*#__PURE__*/ add(1, 2); 这一行(因为没用到返回值,且声明了 PURE),而 log 因有副作用且被调用,保留。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

5126

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1269

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

5044

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

980

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1916

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3605

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4693

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

3080

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

988

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.3万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.7万人学习