JavaScriptで文字列の配列からコメントを削除する方法

この記事では、JavaScriptを使って文字列の配列からコメント部分を削除する方法について解説します。

問題

文字列の配列 arr を第一引数として、特殊文字の配列 starters を第二引数として受け取るJavaScript関数を作成する必要があります。

starters 配列には、コメントの開始となり得る文字が格納されています。作成する関数は、配列 arr を走査し、各文字列に含まれるコメントをすべて削除した結果を返すものとします。

例えば、関数への入力が次のような場合を考えてみましょう。

const arr = [
   'red, green !blue',
   'jasmine, #pink, cyan'
];
const starters = ['!', '#'];

この場合、期待される出力は次のようになります。

const output = [
   'red, green',
   'jasmine,'
];

「!」以降と「#」以降がコメントとして扱われ、それぞれの文字列から取り除かれているのがわかります。

アプローチ

この問題は、各文字列を1文字ずつ順番に確認しながら処理するシンプルな手法で解決できます。基本的な考え方は以下の通りです。

• コメント開始文字が現れるまでは、通常どおり文字を読み取って結果に追加する。
• コメント開始文字が見つかったら、フラグを切り替えて以降の文字を無視する。同時に、コメント直前の余分な空白も削除する。
• 改行文字「\n」が現れたら、コメント状態を解除し、再び文字を読み取るモードに戻す。

コード例

上記のアプローチを実装したコードがこちらです。

const arr = [
   'red, green !blue',
   'jasmine, #pink, cyan'
];
const starters = ['!', '#'];

const removeComments = (arr = [], starters = []) => {
   const res = [];
   for (let i = 0; i < arr.length; i++) {
      let str = '';
      let flag = true;
      for (let x of arr[i]) {
         if (starters.includes(x)) {
            // コメント開始文字を検出 → コメントモードへ移行
            flag = false;
            // コメント直前の余分な空白を削除
            str = str.replace(/\s+$/, '');
         } else if (x === '\n') {
            // 改行でコメントを終了
            flag = true;
         }
         if (flag) str += x;
      }
      res.push(str);
   }
   return res;
};

console.log(removeComments(arr, starters));

コードの解説

処理の流れをもう少し詳しく見ていきましょう。

• 外側のループ： 配列 arr の各文字列を1つずつ処理します。
• 内側のループ： for...of 構文で文字列を1文字ずつ走査します。
• コメント検出時： 現在の文字が starters に含まれていれば、flag を false にしてコメントモードに移行します。このとき正規表現 /\s+$/ を使って、コメント開始前の不要な末尾空白を取り除いています。
• 改行の検出： 改行文字を見つけると flag を true に戻し、次の行では再び通常の文字を読み取れるようにします。
• 結果の構築： flag が true の間だけ文字を str に連結し、各行の処理が終わったら結果配列 res に追加します。

出力

このコードを実行すると、コンソールには次のように出力されます。

[ 'red, green', 'jasmine,' ]

このように、指定した開始文字以降のコメント部分がきれいに除去された文字列の配列が得られます。設定ファイルや簡易テキスト形式のパースなど、独自のコメント記法を持つデータを扱う際に役立つテクニックなので、ぜひ覚えておきましょう。