萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

JavaScript 正則移除程式碼註解(單行 // 與多行 /* */)

核心正則

/**
 * 移除 JS/JSON 程式碼中的註解,保留字串字面值
 * @param {string} code - 原始碼
 * @returns {string} 移除註解後的碼
 */
function stripComments(code) {
    // 正則結構:4 個捕獲組
    // 1. 雙引號字串 "..." (支援逸出)
    // 2. 單引號字串 '...' (支援逸出)
    // 3. 模板字面值 `...` (支援 ${} 巢狀、逸出)
    // 4. 單行註解 // ...
    // 5. 多行註解 /* ... */
    const regex = /("(?:[^"\\]|\\.)*")|('(?:[^'\\]|\\.)*')|(`(?:[^`\\]|\\.)*`)|(\/\/[^\n\r]*)|(\/\*[\s\S]*?\*\/)/g;

    return code.replace(regex, (match, dq, sq, tm, sl, ml) => {
        // 如果是字串/模板字面值,保留原樣
        if (dq || sq || tm) return match;
        // 否則是註解,替換為空字串(或保留換行以維持行號)
        return sl ? '\n' : ''; // 單行註解保留換行,多行註解直接移除
    });
}

// 測試
const source = `
const x = 1; // 這是單行註解
const y = "字串裡的 // 不是註解";
/* 多行
   註解 */
const z = \`模板 \${1+1} 裡的 /* 也不是註解 */\`;
`;
console.log(stripComments(source));
/* 輸出:
const x = 1; 
const y = "字串裡的 // 不是註解";

const z = \`模板 \${1+1} 裡的 /* 也不是註解 */\`;
*/

正則詳細拆解


/(
    "(?:[^"\\]|\\.)*"     # 雙引號字串:非引號非反斜線、或逸出序列
  | '(?:[^'\\]|\\.)*'     # 單引號字串
  | `(?:[^`\\]|\\.)*`     # 模板字面值(簡化版,實際 ${} 巢狀較複雜)
  | \/\/[^\n\r]*          # 單行註解:// 後接任意非換行字元
  | \/\*[\s\S]*?\*\/      # 多行註解:/* ... */ 非貪婪匹配跨行
)/g

關鍵點解析

  1. 順序很重要:字串模式必須在註解模式之前,否則字串內的 // 或 /* 會被誤判為註解。
  2. 非貪婪 *?:多行註解 [\s\S]*? 必須用惰性量詞,否則會吞掉中間的程式碼直到最後一個 */。
  3. 替換函式判斷:利用捕獲組參數判斷匹配到哪一類,字串保留、註解移除。
  4. 保留行號:單行註解替換為 \n 而非空字串,避免錯誤堆疊行號偏移。

擴充:支援更完整的模板字面值

模板字面值可包含 ${...} 巢狀表達式,完整正則較複雜,建議用成熟函式庫:

  • strip-comments (npm):npm i strip-comments
  • babel-plugin-transform-remove-comments:建置時移除
  • terser:壓縮時自動移除註解

應用場景

  • 程式碼編輯器預覽/分析
  • 建置流程中壓縮前預處理
  • 安全掃描:移除註解後再做靜態分析
  • 教學工具:展示核心邏輯隱藏註解

原始碼問題修正

原文正則 /{2,}.*?(r|n)|(/\*(n|.)*?\*\/)/ 缺少字串保護,會誤刪字串內的類註解字序。上方方案完整處理雙引號、單引號、模板字面值三種字串類型。

copyright © 萬盛學電腦網 all rights reserved