Javascriptのコメント文をどうにかしたい

覚書き的な内容をコメントに残したいけど、それを見られるのはちょっと恥ずかしい・・・ので対策を考える

作成日:2022-09-15, 更新日:2022-09-15

やりたいこと

  • テスト環境ではコメントが表示されていてもOK
  • 本番環境ではコメントを非表示にしたい

→覚書き的なコメントなのであんまり見られたくない。そんなコメントを残さないってのが本筋かもしれない

対応案

  • 本番環境用に手動でコメントを削除
  • 本番環境用に「.min.js」みたいなヤツをつくり、環境に合わせて読み込ませるファイルを変更
  • ソースマップの利用
  • 別案を考える

本番環境用に手動でコメントを削除

そんな面倒なコトはしたくない

本番環境用に「.min.js」みたいなヤツをつくり、環境に合わせて読み込ませるファイルを変更

Prepros(プリプロス): SASS/SCSS、JSのコンパイル」をインストールして「.min.js」を作ってもらう
ただ、1行になるので本番環境のデバッグが面倒になる
→本番環境で不具合があったとしても本番環境上で、デバッグをしないなら問題無し

ソースマップの利用

よくわからん。

別案を考える

  • PHPファイルでscriptを作成
  • 作成したPHPファイルをフッタに出力
  • 追加のJavascriptは「$(function(){});」で囲む

これの問題点はPHPの記載箇所の後の最初の改行がちょっとおかしくなる

サンプル: scriptファイル

▼script.php

<script>
  let hoge = function(){
    <?php // PHPでコメントしているので出力されない ?>
    // ただのコメントなので出力される
  }
</script>

サンプル: フッタ

~ 省略 ~
<?php echo file_get_contents('script.php'); ?>
</body>
</html>

サンプル: 追加のJavascriptがある場合

~ 省略 ~
<script>
  $(function(){
    let foo = function(){
      ...
    }
  });
</script>
~ 省略 ~
<?php echo file_get_contents('script.php'); ?>
</body>
</html>