*JavaScriptは、HTMLとともにウェブブラウザで処理できるプログラミング言語として人気があります。*JavaScriptはブラウザのエンジンで処理されるスクリプト言語で、簡単にプログラミングを始めることができます。

プログラミングを進めていくと、機能拡張のたびに小規模なコードもどんどん複雑化し、保全性の確保が重要になります。ここでは、デバッグコードの埋め込みや注釈の記述に用いるコメントアウトについて理解を深めていきましょう。

JavaScriptは、オブジェクト指向のスクリプト言語です。ウェブページにボタン操作などのインタラクティブ性を持たせることができます。非同期処理による並行処理や、マルチスレッド・プログラミングも可能です。*ECMAによって標準化されており、ECMAScriptとして言語仕様が定義されています。*

【参考】：[ECMA: ECMA-262](https://ecma-international.org/publications-and-standards/standards/ecma-262/)

オブジェクト指向言語とは？概念とプログラミング言語をわかりやすく解説！

### そもそもコメントアウトとは

*コメントアウトとは、プログラミングで使用するソースコードにコメント機能を用いて追記することです。*コメント機能で追記した内容は、プログラム処理から除外されます。一般的には注釈をソースコードに入れたり、デバッグコードをコメント化する際に行います。

次の例は、通常のJavaScriptです。デバッグ用にconsole.log()で”Hello World”を表示させています。

```
process.stdin.resume();
process.stdin.setEncoding('utf8');
// コメントアウトしていない状態
console.log("Hello World");```

もしデバッグ用コードが不要になった場合は、コメントアウトによってコメント化することができます。書き方はシンプルでコメントアウトの前に”\/\/”を追加し、コメント化を行うことができます。

```
process.stdin.resume();
process.stdin.setEncoding('utf8');
// コメントアウトした状態
// console.log("Hello World");```

このコメントアウトにより、console.log()は無効化され”Hello World”は表示されなくなります。JavaScriptライブラリのjQueryでも、同様の考え方でコメントアウトが利用できます。

【参考】：[jQuery](https://jquery.com/)

コメントアウトは、コードを無効化したりソースコードに注釈をいれたりすることを指します。JavaScriptにおいても、注釈を入れることで保全性が高まります。

*後日コードを見直したり、プロジェクトメンバーでメンテナンスしたりする場合に、誰がどのような意図で変更したのかがすぐに分かるため、コードの品質を高めることができます。*

統合開発環境（IDE）やエディタでは、コメントアウトを簡素化するためにショートカットキーを設定している場合があります。詳しくは利用中の編集ツールの機能を確認しましょう。

IDEとは？詳細やメリット、おすすめのIDEを紹介します！

### JavaScriptのコメントアウトとコードの保全

JavaScriptのコメントアウトは、ソースコードに保存されています。したがってウェブブラウザに表示しない場合も、ソースコードを表示するとコメント内容が確認できます。*そのためにソースコードの流出が気になる場合は、コードを見せないために別の手を講じる必要があります。*

このソースコードの記載内容を利用者に見せたくない場合は、JavaScriptのコードを分離して、外部ファイルから読み込んだり難読化したりするなどを別途検討する必要があります。

*JavaScriptのコメント機能はいくつかあります。*仕様はECMAScript言語仕様書で定義されています。最新の言語仕様書は、「ECMAScript 2023 Language Specification」です。ここからは、この最新の言語仕様書で定義されている、コメント機能を解説していきます。

【参考】：[ECMAScript® 2023 Language Specification](https://262.ecma-international.org/14.0/?_gl=1*jnya98*_ga*MTIyMjAzNTkwMS4xNzA5NjExMjY5*_ga_TDCK4DWEPP*MTcwOTYxMTI2OS4xLjEuMTcwOTYxMTY1Ni4wLjAuMA..)

*SingleLineComment（シングルライン・コメント機能）とは、1行で記述するコメント機能です。*行単位で”\/\/”を挿入し、それ以降はコメントとして扱われます。使い方はシンプルで、次のように用います。

```// この行はコメントです。
const a = 10; // この行は実行されます。実行ステートメントより右は、コメントです。
// 行単位でコメントを指定します。```

*MultiLineComment（マルチライン・コメント機能）とは、複数行を対象とするコメント機能です。*特定の命令ブロックを囲ったり、長い説明文を追記するのに使用します。”\/\*”でコメントが開始され、”\*\/”でコメントが終了します。

```/* この行はコメントです。
この行もコメントです。
　　：
この行までをコメントと解釈します。*/```

Hashbangとは、UnixやLinuxのシェルスクリプトで用いる手法です。ECMAScript 2023の言語仕様書で正式に追加されました。*スクリプトファイルの先頭行に、”#!”で始まる行を記述するコメント機能です。*

Node.jsなど、V8を使用してサーバーサイドJavaScriptインタープリタを実行する際にパスを指定することができます。同様に処理によって任意のインタープリタを指定することもできます。クライアントJavaScriptでは、単なるコメントと解釈されます。

```#!/v8のパス/v8-shell  // 先頭行のコメントです
// これ以降に実際のコードを記述します```

## JavaScriptの非推奨コメント機能

JavaScriptでは、互換性維持を目的とした非推奨の機能も定義しています。ECMAScriptの付随書であるAnnex Bが該当します。*これらの機能は、互換性維持を目的とするレガシー機能であり、ウェブブラウザ自体に機能を盛り込みますが、JavaScriptのコードにいれることは推奨されません。*

ここでは、メンテナンス知識を高めるために非推奨のコメント機能についても解説していきます。

*HTML-like Commentは、古いバージョンのブラウザでJavaScriptを動作させるための仕様です。*昔のブラウザでは、JavaScriptを解釈できないことから、コメント行として解釈を無効化する必要がありました。その古いブラウザでの動作を保証するために、この機能は引き続き提供されます。

*・SingleLineHTMLOpenComment*
SingleLineHTMLOpenComment（シングルラインHTMLオープンコメント）は、コメントの開始を意味します。”\<!\-\-”を指定します。

*・SingleLineHTMLCloseComment*
SingleLineHTMLCloseComment（シングルラインHTMLクローズコメント）は、コメントの終了を意味します。”\-\-\>”を指定します。

*・使い方*
次のように、JavaScriptのコードをSingleLineHTMLOpenCommentとSingleLineHTMLCloseCommentで挟みます。HTML-like Comment自体は、コメントとして処理され、間に記述した”const a = 10;”と”console.log("Hello World");”はJavaScriptコードとして処理されます。

```<script language="javascript">

</script>```

古いブラウザバージョンでJavaScriptが解釈できない場合も、HTMLのコメントアウトと同等と認識されることから、コード全体がコメントアウトされ解釈から除外されます。このコメント機能は、現在非推奨ですが、互換性維持のために残されています。

## JavaScriptのコメントアウトを活用して保全性を高めよう

JavaScriptは手軽に始められるスクリプト言語で、ウェブブラウザ搭載のエンジンで処理できるため、マルチプラットフォームで動作させることが簡単にできます。ソースコードが大規模化してくると、保全性を高めるためにもコメント機能が欠かせません。

**デバッグコードのコメントアウトや修正箇所の注釈の追加など、メンテナンス性を高めるために積極的に活用しましょう。**

JavaScriptは、1995年に開発されてからウェブベースのアプリケーション開発に欠かせないものになっています。この記事ではJavaScriptを使用したソースコードを保全するために、コメントアウトの考え方や使用方法を解説します。

JavaScriptは、ウェブプログラミングで人気のあるスクリプト言語です

コードのメンテナンス性を高めるために、コメント機能が提供されます

コメント機能はいくつか提供されるため、使い分けながらソースコードを開発します

JavaScriptのコメントアウトとは？考え方や使用方法を解説

[【関連記事】【Pythonのライブラリ管理ツール】pipインストールを徹底解説！Windowsでも簡単？](https://and-engineer.com/articles/YcJyaRAAACMAl3BX)

[【関連記事】PythonのコードをEXE化するには? PyInstallerやその他ツールの特徴や使い方](https://and-engineer.com/articles/ZDZ41BEAAH-qRRlT)

[【関連記事】Pythonで自動化できること7選！面倒な作業を効率化してより便利に](https://and-engineer.com/articles/YRn2KRAAACIA6YPW)<br>

Pythonとは、機械学習など最先端の分野でも使われている人気の高いプログラミング言語です。*Pythonには、既存のコードを流用して開発効率を高める機能が備わっている「モジュール」があります。*

Pythonは他のプログラミング言語と比べて様々な分野に利用できる豊富なモジュールと、それらをまとめたパッケージやライブラリが存在するため、他の言語と比べても高度な開発をよりスピーディーに行いやすい点が魅力です。

Pythonの用途別ライブラリ14選！おすすめの本も紹介

### Pythonのモジュールを活用するには

モジュールはimport文を使って簡単に呼び出すことができますが、*効果的にモジュールを利用するためには、どのようなモジュールが存在するのか、それを使って何ができるのかをある程度理解しておく必要があります。*

ただし、Pythonのモジュール数はあまりにも膨大であり、それらすべてを1つずつ理解しようとするのは大変です。

ここでは、標準モジュール・外部モジュールからそれぞれ特に利用頻度の高い便利なモジュールを厳選して、一覧表示で紹介します。

pipとは？Pythonのライブラリ管理方法を分かりやすく解説！

## Pythonの便利な標準モジュール一覧

Pythonの標準モジュールは、Pythonにプリインストールされており、インストールなどの特別な作業なしに利用できます。

**標準モジュールにはどのような用途にも利用できる基本的で汎用的な機能を備えているものが多いため、Pythonを学び始めた段階でも、専門的で高度なプログラムを開発したい場合でも活躍します。**

そんな標準モジュールの中でも、利用頻度の高い基本的なモジュールを具体的な使用例を交えて一覧で紹介します。

*datetimeは、日付や時間を扱うモジュールです。*例えば、現在の時刻を取得するnowメソッドや、日付同士の演算をするtimedeltaクラスなどを利用できます。

# 現在の日時の一日前の日時を取得する

yesterday = now + datetime.timedelta(days=-1)

【参考】：[datetime --- 基本的な日付型および時間型 — Python 3.12.2 ドキュメント](https://docs.python.org/ja/3/library/datetime.html)

*calendarは、その名の通りカレンダーを扱うモジュールです。*例えば、年月を指定してカレンダーを表示するmonth関数や、HTML形式で出力するHTMLCalendar関数が利用できます。

htmlcal = calendar.HTMLCalendar(firstweekday=0)

print(htmlcal.formatmonth(year,month, withyear=True))

【参考】：[calendar --- 一般的なカレンダーに関する関数群 — Python 3.12.2 ドキュメント](https://docs.python.org/ja/3/library/calendar.html)

*reは、正規表現を扱うモジュールです。*例えば、正規表現パターンのオブジェクトを作って繰り返し使えるようにするcompiteメソッドや、文字列を検索するmatchメソッド、文字列を置換するsubメソッドなどが利用できます。

msg = "モジュールはとても便利です"

# 正規表現パターンオブジェクトを生成する

<re.Match object; span=(0, 2), match='モジュール'>

【参考】：[re --- 正規表現操作 — Python 3.12.2 ドキュメント](https://docs.python.org/ja/3.12/library/re.html)

*mathは、数学的な計算を扱うモジュールです。*指数関数や三角関数、浮動小数点など高度な計算を扱う関数を複数備えています。初歩的なところでは、円周率を取得するpi関数や、小数点以下を削除するtrunc関数などが利用できます。

【参考】：[math --- 数学関数 — Python 3.12.2 ドキュメント](https://docs.python.org/ja/3/library/math.html)

*randomは、その名の通り乱数を扱うモジュールです。*乱数は実行するたびに値が変わるため、くじ引きのような実行するたびに結果を変えたい処理に利用します。

例えば、範囲内のランダムな整数を取得するrandint関数や、引数に指定された要素をランダムに取得するchoice関数などが利用できます。

# 1~5までの整数をランダムに取得する

Pythonのモジュールには、あらかじめ備わっていて一般的な用途を網羅している標準モジュールと、自分や第三者が作成した外部モジュールがあります。ここでは、それぞれ利用頻度の高い便利なモジュールを厳選して実例とともに一覧で紹介します。

モジュールを使いこなすには、どのようなモジュールが存在するかを知ることが重要

標準モジュールはプリインストールされていて、すぐに使える汎用的な機能が多い

外部モジュールはPyPIからインストールが必要で、専門性が高い機能が多い

便利なPythonモジュールの一覧！おすすめ外部ライブラリも紹介

[【関連記事】Pythonで自動化できること7選！面倒な作業を効率化してより便利に](https://and-engineer.com/articles/YRn2KRAAACIA6YPW)

[【関連記事】Anacondaの使い方は？Python環境の利用方法を解説！](https://and-engineer.com/articles/YRsidxAAACRz7tnv)<br>

Pythonは、初心者でも簡単に習得できるプログラミング言語の1つです。インタープリター型であるPythonスクリプトのコード開発には、数多くの公開ライブラリが活用できます。

*Pythonでは開発したスクリプトコードを配布して利用できますが、ターゲット環境にもPythonが必要であり多少の準備が必要です。*コンパイラ言語のようにEXEファイルを配布したい場合もあるでしょう。

そこで、ここではPythonのコードをEXE化して利用する方法を解説します。

Pythonとは？人気の理由と基本知識をわかりやすく解説！

Pythonでできることは？初心者が作れるものや実用例を紹介

### PythonのコードをEXE化するメリット

PythonのコードをEXE化するメリットですが、次の3点を紹介します。

*1つ目は、ターゲットとなる実行環境にPythonが不要である点が挙げられます。*ソフトウェア開発者はPythonの開発環境を用意している場合が多いですが、ユーザ環境やオペレータ向けの環境では開発環境を導入することができません。

この場合でもEXE化しておけば、開発したコードを配布し利用できるメリットがあります。

*2つ目は、ソフトウェアの実装部分などアルゴリズムやコード自体の流出を防止することです。*Pythonのコードはインタプリタ言語であるため、ファイルの中身を見るとソフトウェアの構造が分かってしまいます。

使用許諾を設定できるものの、編集や修正で簡単に組み込まれてしまいますので、ソースプログラムの開示を防ぎたい場合に有効です。

*3つ目としては、実行手順が簡略化できるメリットがあります。*実行ファイルをダブルクリックするだけで起動しますので、アイコンを設定するなどして分かりやすく、複雑な操作をせずに実行する実行環境が簡単に構築できます。

Pythonの環境構築：公開ソフトウェアを活用した環境整備を解説

### PythonのコードをEXE化するデメリット

Pythonはインタプリタ言語であり、ソースコードを機械語に解釈しながら実行します。そのため、どのOSでも同じコードが実行できるメリットがあります。

コードをEXE化する場合は、Windows版のEXEコード、macOS版のEXEコードなどのように、実行互換性が同一OSに限定されてしまうデメリットがあります。*OS毎にEXEコードを準備する必要がありますので、実行環境は簡単に準備できるものの配布する手間が増えてしまいます。*

そして実行時に不要なライブラリを含んで読み込むために、処理が遅くなる場合もあります。このこともデメリットとして挙げられる点です。

### PythonのコードをEXE化するツール

*PythonのコードをEXE化するには、コードの変換ツールをPython環境に追加導入して使用します。*具体的には、PyInstaller・py2exe・py2app・Nuitka・cx\_Freeze・PyOxidizerなどのツールが公開されており、お気に入りのツールを準備します。詳細は以降で解説していきます。

Pythonで開発を行う際におすすめのツールを徹底解説！

## PythonのコードをEXE化するツールを比較する

*PythonのコードをEXE化するツールは、いくつかあります。*使用中の環境でニーズに合うものを比較すると良いでしょう。以降では、それぞれのツールの特徴を踏まえて解説します。

【Pythonのライブラリ管理ツール】pipインストールを徹底解説！Windowsでも簡単？

PythonのコードをEXE化する際の第1候補のツールです。*実行時のオプションが多数実装されており、実際にEXEファイルを配布する際にもニーズに合う実行ファイルを生成することができます。*

WindowsやmacOS、GNU/Linux・AIMやSolarisなど多数の環境で動作します。弱点としては、ファイルサイズが大きめである点が挙げられます。

インストールするには、次のようにpipからインストールします。

基本的な実行方法は以下のように、pyinstallerコマンドでEXE化するPythonファイル名を引数として渡すだけです。

```pyinstaller EXE化するPythonファイル.py```

PyInstallerは、スクリプトコードと同じフォルダに ”.spec”ファイルを作成し、”build”と”dist”のフォルダを生成します。EXE化したファイルは、”dist”フォルダに格納されます。追加するオプションは多数ありますが、”--onefile”や”--noconsole”などを選ぶ場合があります。

”--onefile”は、実行ファイルを1つに集約するオプションです。再配布する場合などに使用します。

”--noconsole”は、WindowsとmacOS向けのオプションで、コマンド入力のコンソールウィンドウを表示しないオプションです。”.pyw”のGUIでは”--noconsole”のオプションは影響しません。

オプションの指定方法は、次の通りです。

```pyinstaller EXE化するPythonファイル.py --onefile --noconsole```

”--onefile”は、単一ファイルですがファイルサイズが大きくなります。軽量化する場合は、デフォルト設定を用います。

【参考】：[PyInstaller](https://pyinstaller.org/en/stable/)
【参考】：[PyInstaller Requirements](https://pyinstaller.org/en/stable/requirements.html#pyinstaller-requirements)
【参考】：[PyInstaller Using PyInstaller](https://pyinstaller.org/en/stable/usage.html)

まずはPyInstallerを使ってみて、用途に合わない場合はPyInstaller以外のツールを試してみるのが良いでしょう。

*py2exeは、Windowsの実行ファイルを作成するツールです。*Python 3とPython 2向けのバージョンが、それぞれ公開されています。

インストールは、次のようにpipから行います。

使用するには、事前にセットアップ用スクリプト（setup.py）を用意しておきます。記述方法は次の通りです。

setup(console=['EXE化するPythonファイル.py'])```

実行方法は次のように行います。

EXE化したファイルは、必要となるモジュールすべてが ”dist”フォルダに格納されます。このフォルダを圧縮するなどして、再配布します。なおソースのコンパイルはMicrosoft Visual Cが使用されるため、実行環境にはMicrosoft Visual CのランタイムDLLが必要です。

【参考】：[py2exe](https://www.py2exe.org/)
【参考】：[GitHub py2exe](https://github.com/py2exe/py2exe)
【参考】：[py2exe Tutorial](https://www.py2exe.org/index.cgi/Tutorial)

*py2exeがWindows版であったのに対して、py2appはMac版（macOS）で動作する実行ファイルを作成します。*インストール手順には、次のように大きな違いがありません。

使用するにはpy2exe同様に、事前にセットアップ用スクリプト（setup.py）を用意しておきます。py2app 0.3からは、それまでのdistutilsではなく、setuptoolsを使用します。記述方法は次の通りです。

    app=["EXE化するPythonファイル.py"],

配布するには、”dist”フォルダをアプリケーションバンドルとして使用します。EXE化するPythonファイル.appが生成されます。“build”フォルダに作業の生成物（残骸）が残りますがこちらは使いません。再配布する場合は、Finderから生成されたアプリを右クリックし、「Create Archive」を選びます。

【参考】：[py2app](https://py2app.readthedocs.io/en/latest/)
【参考】：[py2app Installation](https://py2app.readthedocs.io/en/latest/install.html)
【参考】：[py2app Tutorial](https://py2app.readthedocs.io/en/latest/tutorial.html)

py2appの場合は、動作しないなどうまくできない例も挙げられていますので、利用する場合はじっくりと取り組む必要がありそうです。

Nuitkaは、Pythonコンパイラと称しているツールです。*Pythonで書かれた最適化コンパイラです。*Python Version 2.6や 2.7、そして3.3以降の多数のバージョンに対応し、完全互換があります。

具体的には、PythonのコードをC言語のソースコードにコンパイルするため、別途MinGW64やVisual Studio 2022、gcc・clangなどのCコンパイラが必要です。

Nuitka Standardという通常版の他に、商用版のNuitka Commercialが提供されています。WindowsやmacOS、Linux・FreeBSD・NetBSDに対応します。ソースコードからソースコードへの変換を行い実行ファイルを作成するために、実行ファイルのサイズは小さくなる傾向があります。

次のようにpipからインストールします。

```python -m nuitka EXE化するPythonファイル.py```

実行時には、Cキャッシングツール（Cコンパイラ）が聞かれます。Visual StudioのMSVCがインストールされている場合以外は、MinGW64ベースのCコンパイラをダウンロードするよう表示されます。

実行時のオプションは、”--onefile”で1つに集約され、”--standalone”で”.dist”フォルダに分けて格納されます。いずれかの方法で配布モジュールを作成します。なお関連モジュールの追加は、”--enable-plugin”で指定します。

指定が必要な場合は、Nuitkaの実行時のメッセージに「WARNING」が表示されます。この表示に従って、オプションを追加します。

【参考】：[Nuitka](https://nuitka.net/)
【参考】：[GitHub Nuitka](https://github.com/Nuitka/Nuitka)
【参考】：[Nuitka User Manual](https://nuitka.net/doc/user-manual.html)

cx\_Freezeは、20年ほどの長い実績があり、多くのバージョンがあります。そのため、*Pythonのバージョンに対応した、cx\_Freezeのバージョンを選ぶ必要があります。*ファイルサイズは比較的小さめです。

Pythonのコードはスクリプト形式で実行されますが、EXE化することで実行するPCにPythonの環境が不要になり、何かと便利です。ここでは、PythonのコードをEXE化するメリット・デメリットとともに、各ツールの特徴や使い方を解説していきます。

Pythonは、簡単に始められるインタープリター型のプログラミング言語です

コードをEXE化すると、実行するPCにPythonの環境が不要となり、操作が簡略化できます

EXE化にはツールが必要で、要望に合わせて色々なツールが公開されています

PythonのコードをEXE化するには？PyInstallerやその他ツールの特徴や使い方

PHPは、サーバーサイドのウェブプログラミングで用いられる汎用プログラミング言語です。HTMLに埋め込んで使用されるなど、HTMLのプリプロセッサとして実績があります。**PHPはソースコードのメンテナンスのために、多くのコメント機能が実装されています。**

ここでは、PHPのコメントアウトの概要から使い方まで解説していきます。

【参考】：[PHP](https://www.php.net/)

PHPの入門として概要やプログラムの記載方法、文法について解説

*コメントアウトとは、プログラミングにおいて、ソースコードのデバッグコードなど不要なコードを無効化したりコードの説明文を注釈として記述したりすることです。*PHPではコメントアウトするために、言語仕様にコメント機能を定義して対応しています。

### PHPにおけるコメントアウトの活用方法

通常、ブラウザで「ページのソースを表示」を選択すると、HTMLではコメントアウト部分も表示されます。*PHPは、動的コンテンツを生成するため、PHPでコメントアウトした部分はHTMLのコードには表示されません。*

ソフトウェア開発のバージョン情報や変更内容など、情報流出が心配な場合は、PHPのコード部分にコメント機能で注釈を入れることで、コメントの非表示化が可能です。

## PHPのコメントアウトの種類と使い方

PHPのコメント機能はいくつかあります。*主要なものは、C++型の単一行用のコメント、シェル型の単一行用のコメント、複数行用のコメントの3種類です。*まず最初は、これら3種類のコメント機能を学んでいきます。

【参考】：[PHP マニュアル / 言語リファレンス / 基本的な構文 / コメント](https://www.php.net/manual/ja/language.basic-syntax.comments.php)

### C++型の単一行用のコメント機能

*C++型の単一行用のコメント機能は、”\/\/”を先頭に記述するコメントアウト形式です。*”\/\/”は行頭に記述したり、各行の右側に追記したりして使用します。このコメントアウト形式は、行単位で記述します。

使い方は、次のように行います。

```
<?php
echo 'Hello World';   // ここにコメントを記述します
?>```

### シェル型の単一行用のコメント機能

*シェル型の単一行用のコメント機能は、”#”を先頭に記述するコメントアウト形式です。*”#”は行頭に記述したり、各行の右側に追記したりして使用します。このコメントアウト形式は、C++型同様に行単位で記述します。

```
<?php
echo 'Hello World';   # ここにコメントを記述します
?>```

*複数行をまとめてコメントアウトするには、複数行用に提供されるコメント機能を用います。*”\/\*”でコメントが開始し、”\*\/”で終了します。単一行でも使用できますが、複数行にわたるプログラムをコメントアウトしたり、説明用の注釈を入れたりする際に利用するのが良いでしょう。

```
<?php
/*
ここにコメントを記述します
   ：
   ：
*/
?>```

### 複数行用のコメント機能の留意点

複数行用のコメントは、”\/\*”の後の”\*\/”で終了します。*複数行用コメントの入れ子はできません。*次のように記述すると、コメント終了が正しく解釈されずエラーとなります。

```
<?php
/*
echo 'Hello World';  /* このコメント終了の文字が入れ子になってしまい、エラーとなります */
*/
?>```

正常にコメントアウトするには、次のように行ごとのコメントアウトにおいて、単一行用のコメント機能を使います。

```
<?php
/*
echo 'Hello World'; // このコメントは問題ありません
echo 'Hello World'; # このコメントは問題ありません
*/
?>```

### 3種類のコメント機能を使い分ける

これまでに、PHPでは主要な3種類のコメント機能があることがわかりました。*それぞれのコメント機能の利用方法には明確な制限がありませんが、プロジェクトなど大規模なソフトウェア開発においては、コメントアウトのルール決めをしておきましょう。*

例えば、次の例のようにPHPの大見出しをつけたり、後述するドキュメントコメントを埋め込んだりします。個々の注釈は単一行用のコメント機能を用いるのが良いでしょう。

```
<?php
//
// 大見出しをつける
//
 
/**
 * ドキュメントコメント（後述します）
 * 提供する機能の概要や、
 * 使用方法などを記載する
 */
 
// デバッグコードを次のようにコメントアウトする
# echo 'Test';
?>```

### 正規表現でコメント機能を利用する

*PHPでは、正規表現においてもコメント機能を利用することができます。*”(?#”と”)”で囲った部分がコメントアウトされて処理されます。以下の例では、正規表現中にコメント機能で注釈をいれていますが、検索パターンから除外されるため、同じ文字列パターンとして処理が行われます。

```
<?php
$subject = 'Search Pattern';
$results = preg_match('/Search (?# この部分はコメントアウトされます)Pattern/', $subject);
var_dump($results);
?>```

【参考】：[PHP マニュアル / 関数リファレンス / テキスト処理 / 正規表現 (Perl 互換) ](https://www.php.net/manual/ja/book.pcre.php)
【参考】：[PHP マニュアル / 関数リファレンス / テキスト処理 / PCRE / PCRE のパターン / PCRE 正規表現構文 / コメント](https://www.php.net/manual/ja/regexp.reference.comments.php)
【参考】：[PHP マニュアル / 関数リファレンス / テキスト処理 / PCRE / PCRE 関数 / preg_match](https://www.php.net/manual/ja/function.preg-match.php)

また、PCRE_EXTENDEDオプションを設定することで、”#”以降をコメントとしてパターンから除外することもできます。

```
<?php
$subject = 'Search Pattern';
$results = preg_match('/Search # この部分はコメントアウトされます
Pattern/', $subject);
var_dump($results);
?>```

【参考】：[PHP マニュアル / 関数リファレンス / テキスト処理 / PCRE / PCRE のパターン / パターン修飾子](https://www.php.net/manual/ja/reference.pcre.pattern.modifiers.php)

ドキュメントコメント（DocComment）とは、”\/\*\*”で始まり”\*\/”で終わるコードのコメントを指します。*クラスや関数などの機能や引数、戻り値などを記載するコメントです。*次のようにコードの前に、記述しておきます。

```
<?php
/**
 * Debug Class / デバッグ用クラス （概要を記載）
 * （必要な詳細情報を追加）
 *
 * ＠param int $number　（名前や引数など）
 * @return array | bool　　（戻り値など）
 */
class DebugClass {}
 
$RefC = new ReflectionClass('DebugClass';
var_dump($RefC->getDocComment());
?>```

このようにソースコードの保全性を高めるために、コメントを残すなどのルール付けをするのが良いでしょう。上記サンプルコードで使用したgetDocComment()は、ドキュメントコメントを取得する関数です。コードのメンテナンスに使用すると良いでしょう。

【参考】：[PHP マニュアル / 関数リファレンス / 変数・データ型関連 / リフレクション / ReflectionClass / ReflectionClass::getDocComment](https://www.php.net/manual/ja/reflectionclass.getdoccomment.php)
【参考】：[PHP マニュアル / 関数リファレンス / 変数・データ型関連 / リフレクション / ReflectionProperty / ReflectionProperty::getDocComment](https://www.php.net/manual/ja/reflectionproperty.getdoccomment.php)
【参考】：[PHP マニュアル / 関数リファレンス / 変数・データ型関連 / リフレクション / ReflectionClassConstant / ReflectionClassConstant::getDocComment](https://www.php.net/manual/ja/reflectionclassconstant.getdoccomment.php)
【参考】：[PHP マニュアル / 関数リファレンス / 変数・データ型関連 / リフレクション / ReflectionFunctionAbstract / ReflectionFunctionAbstract::getDocComment](https://www.php.net/manual/ja/reflectionfunctionabstract.getdoccomment.php)

PHP8からアトリビュート（Attribute）機能が追加されています。Javaにおけるアノテーションに相当する機能です。*コードの宣言時にメタデータ情報を埋め込むことができます。*メタデータの定義と活用を分離することで、ライブラリやフレームワークへの実装が期待されています。

アトリビュートを定義するには、”#[Attribute]”でクラスを宣言します。利用するには”#[クラス名]”です。PHP7まではそのまま”#”で始まるコメントとして解釈されます。

アトリビュート機能は、行頭の”#”を用いて機能追加していますので単一行用のコメント機能の”#”を多様するコードでは、コンフリクトに注意する必要があります。例えば、PHP8以降では”#[コメント]”の様なコードは、シンタックスエラーとなります。

よりコードの安定性を高めるには、コメントの行頭で用いる”#”をあらかじめ”\/\/”に置き換えておくと良いでしょう。

【参考】：[PHP マニュアル / 言語リファレンス / アトリビュート](https://www.php.net/manual/ja/language.attributes.overview.php)

### エディタで一括コメントアウトするには

*統合開発環境（IDE）やエディタでは、コメントアウトするためのショートカットキーが設定されています。*例えばVSCode（Visual Studio Code）では、Windows版では単一行コメントが「Ctrl」+「/」に設定され、複数行コメントが「Shift」＋「Alt」+「A」にマッピングされています。

詳しくは利用中のエディタのドキュメントを確認しましょう。

【参考】：[Visual Studio Code: Keyboard shortcuts for Windows](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf)
【参考】：[Visual Studio Code: Keyboard shortcuts for macOS](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-macos.pdf)
【参考】：[Visual Studio Code: Keyboard shortcuts for Linux](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-linux.pdf)

基礎知識の記事（5ページ目）