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

[【関連記事】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の用途別ライブラリ14選！おすすめの本も紹介

### 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やその他ツールの特徴や使い方

[【関連記事】AWS資格の難易度はどれくらい？内容や初心者におすすめの勉強方法を解説](https://and-engineer.com/articles/YZtFsREAACIAjrpS)

[【関連記事】AWS認定ソリューションアーキテクト-アソシエイトとは？難易度と勉強方法を解説！](https://and-engineer.com/articles/YXEoUBIAACEANWUF)

[【関連記事】AWS認定クラウドプラクティショナーとは？難易度や勉強時間の目安を解説](https://and-engineer.com/articles/YwGSlRAAACEAsVo8)

## AWSの資格が「意味ない」は本当か？

*AWSに限らずIT業界では、資格取得についての意義を問う「意味ない論争」が勃発する場合があります。*資格取得を推進する企業を除くと、周りの誰も取得していない資格に挑戦するのは役に立つかどうか判断できずに悩む方も多いでしょう。

この記事ではAWSの資格をキャリアアップにつなげるために、どのように資格を位置付けて勉強すべきか解説していきます。

### AWSなどのIT資格を取得する意味合い

AWSの資格の前に、IT資格の傾向を解説します。IT資格には、国家試験として情報処理技術者試験がありますが、資格取得は必須ではないために、軽視される場合もあるかもしれません。周りからの視線を気にしてしまい、断念することもあるでしょう。

ITシステムは複雑なものでも短期間でリリースすることが求められる中、スキルを証明することがクライアントの安心材料になっていることも事実です。**クラウドサービスは一層スキルが求められる領域ですので、AWSにおいても資格取得の目的をもって取り掛かり、実力の証明や市場価値を高めることができます。**

ITエンジニアも資格がある方が有利？おすすめの関連資格を解説！

<center>[エンジニア転職を成功させるため<br/>ぜひ*『マイナビIT エージェント』*をご活用ください！](https://mynavi-agent.jp/it/?utm_source=and-engineer&utm_medium=content-text&utm_campaign=acv12_2)</center>

## AWSの資格はどのようなものか

AWSでは、スキルの難易度を「AWS Certified Cloud Practitioner」という基礎レベルから用意しています。その後職種に合わせてデベロッパー・ソリューションアーキテクト・アドミニストレータ―において、アソシエイト・プロフェッショナルのレベルを設定しています。

さらに細分化されたスペシャリティという専門レベルの認定も提供されます。勉強方法も多様な選択が可能です。**これらは現状の業務に最適な認定資格の取得が可能で、さらに将来に向けた準備につながります。**

【参考】：[AWS 認定](https://aws.amazon.com/jp/certification/)

AWS認定制度とは？資格取得のメリットや難易度など徹底解説！

この数年、DX（デジタルトランスフォーメーション）が推進され、業務改革も幅広く進んでいます。利用するIT基盤はクラウドサービスが用いられることが増えています。各企業も事業の効率化を図ったり新規サービスを開発したりしています。その仕組みを作るクラウド人材は、市場に一層求められると考えられます。

*AWSでは、自社サービスを高品質に実装して運用できるエンジニアを育成すべく、認定資格を提供しています。*この市場のニーズにおける認定資格では、役割に応じて前述の通りデベロッパー・ソリューションアーキテクト・アドミニストレータ―に分類しています。

日常の業務を担うエンジニアとしても期待される職種と判断できます。

DXとは？その意味と日本の現状、DX推進の障壁となる要因を分かりやすく解説！

前述の通りAWS資格はスキルの難易度に合わせて、基礎レベル、アソシエイト、プロフェッショナル、専門知識の4つに分類されます。各スキルレベルの内容は以下の通りです。

*・基礎レベル（Foundational）*
AWSクラウドの基礎的な理解を目的とした知識ベースの認定であり、クラウドを初めて利用する実務経験なしの非IT職に従事する人でも取得を目指せます。

*・アソシエイト（Associate）*
AWSの知識とスキルを証明し、AWSクラウドのプロフェッショナルとして認定します。クラウドの知識および豊富なオンプレミスでのIT経験があることが望ましいです。初級〜中級レベルです。

*・プロフェッショナル（Professional）*
AWS上で安全かつ最適化された最新のアプリケーションを設計し、プロセスを自動化するために必要な高度なスキルと知識を証明します。2年以上のAWSクラウドの経験があることが望ましいです。

*・専門知識（Specialty）*
機械学習やセキュリティなどの各専門分野における知識を掘り下げ、アドバイザーとしての地位確立を目指します。各分野のスペシャリストとして活躍が期待できます。

現在、AWS資格は以下の13種類存在します。（2024年3月時点）

一部の専門知識（Specialty）の資格は、2024年4月に廃止される予定です。

*【基礎レベル（Foundational）】*
・AWS Certified Cloud Practitioner

*【アソシエイト（Associate）】*
・AWS Certified Sysops Administrator - Associate
・AWS Certified Developer - Associate
・AWS Certified Solutions Architect - Associate
・AWS Certified Data Engineer - Associate

*【プロフェッショナル（Professional）】*
・AWS Certified Solutions Architect - Professional
・AWS Certified DevOps Engineer - Professional

*【専門知識（Specialty）】*
・AWS Certified Advanced Networking - Specialty
・AWS Certified Machine Learning - Specialty
・AWS Certified Security - Specialty
・AWS Certified Database - Specialty（※2024年4月30日に廃止）
・AWS Certified: SAP on AWS - Specialty（※2024年4月30日に廃止）
・AWS Certified Data Analytics - Specialty（※2024年4月9日に廃止）

【参考】：[AWS 認定の廃止と開始のお知らせ | Amazon Web Services ブログ](https://aws.amazon.com/jp/blogs/news/aws-certification-retirements-and-launches/)

AWSの資格一覧・全12種を紹介！取得のメリットや勉強方法も解説

AWSは認定資格の合格率を一切公表していないため、具体的な難易度の算出は難しいですが、国家IT資格と比較することで、おおよその難易度を図ることができます。

例えば、AWS認定ソリューションアーキテクト - アソシエイト（AWS Certified Solutions Architect - Associate）の場合、IPAの「ITパスポート試験」や「基本情報技術者試験（FE）」に近いレベルとされています。ちなみに2つの試験の合格率はどちらも概ね40〜50％です。

*アソシエイトレベルの試験の場合は、難易度は初級〜中級者向けと考えていいでしょう。*プロフェッショナルや専門知識レベルになると、基本情報技術者試験の上位資格相当と考えられるため、難易度はさらに上がります。

【参考】：[ITパスポート試験 | 試験情報 | IPA 独立行政法人 情報処理推進機構](https://www.ipa.go.jp/shiken/kubun/ip.html)
【参考】：[基本情報技術者試験 | 試験情報 | IPA 独立行政法人 情報処理推進機構](https://www.ipa.go.jp/shiken/kubun/fe.html)

【参考】：[情報処理推進機構（IPA）ITパスポート試験Webサイト 統計情報](https://www3.jitec.ipa.go.jp/JitesCbt/html/openinfo/statistics.html)
【参考】：[情報処理技術者試験（基本情報技術者試験）　統計資料](https://www.ipa.go.jp/shiken/reports/ps6vr70000016ew6-att/202401_fe_toukei.pdf)

AWS資格の難易度はどれくらい？内容や初心者におすすめの勉強方法を解説

クラウドを要件から担当するITコンサルタントの年収は「マイナビエージェント 職種図鑑」での平均年収は512万円（※2024年3月執筆時点）、経済産業省2017年発表の「IT関連産業の給与等に関する実態調査結果」から近い職種の高度SE・ITエンジニア（基板設計担当・ITアーキテクト）を参考にすると、平均年収778万円と分かりました。

国税庁2020年発表の「民間給与実態統計調査」における民間企業平均年収は433万円なので、AWSエンジニアのようなITエンジニアは一般平均年収よりも、やや高めであることが分かります。

クラウドシステムのような、需要高まるIT業務では即戦力が求められるため、成果に応じた報酬が期待できます。

AWSが認定する、ソリューションアーキテクトはシステム全体、デベロッパーは開発、アドミニストレーターは運用を想定してクラウド人材の職種を分類しています。*このようなクラウドに特化した高いスキルが求められる現状では、知識を有する人材である証明として、AWSの資格取得が有効活用できるでしょう。*

【参考】：[マイナビエージェント  職種図鑑](https://mynavi-agent.jp/it/jobindex/01.html?utm_source=and-engineer&utm_medium=content-text&utm_campaign=acv12_2)
※【平均年収 調査対象者】2020年1月～2020年12月末までの間にマイナビエージェントサービスにご登録頂いた方
【参考】：[IT関連産業における給与水準の実態① ~ 職種別（P7）](https://warp.da.ndl.go.jp/info:ndljp/pid/11623215/www.meti.go.jp/press/2017/08/20170821001/20170821001-1.pdf)
【参考】：[民間給与実態統計調査-国税庁](https://www.nta.go.jp/publication/statistics/kokuzeicho/minkan2020/pdf/002.pdf)

## AWSの資格が不要と考える理由

AWSの資格が不要と考えるポイントはいくつかあり、資格取得に向けた準備が進まない方も多いでしょう。つい周りの声に同調してしまい、悩んでいる方も多いかもしれません。具体的なポイントは次のような点が挙げられます。

AWSの資格取得を検討している方は、学生よりも社会人の方が多いでしょう。社会人の場合は自由になる時間が限られており、その時間を使って実務で技量を高めることが多いため、*周りの目も実務に長けている人が優秀であると思いがちです。*

資格取得によくある悩みですが、*勉強時間が確保できないためにスキルアップが継続できなくなることがあります。*仕事が忙しくなったり、仕事上の付き合いがあったりしますので、強い意志を持続することも厳しいと感じるようです。

*クラウドサービスが主流になりつつありますが、なかなかその環境に触れる機会がないこともあります。*これでは実務に役立てることは難しいですし、机上のスキルになりかねないと考えてしまうのかもしれません。

AWSで何ができるのか？AWSの概要や強みについても解説

## AWSの資格取得に踏み切れない具体的な例

*AWSの資格取得に踏み切れない方は、悩みながらも最終決断できない場合があります。*ついつい先送りしてしまう理由がどこにあるのか、ここでは具体的に考えていきます。

エンジニアとして実際の技術領域を深く経験していくと、これまでの経験が重視される領域があることも分かってきます。例えば、トラブルシューティングやパフォーマンスチューニングなどは、資格を持っているからと言ってすぐに対応できないことが分かります。

このようなスキルは資格を保有するだけではなく、実務経験とともに対応能力が高まっていくものです。*資格取得を最終ゴールに位置付けるのではなく、常にスキルの高みを目指すことが求められます。*

### AWSの資格には有効期限がある

AWSの認定資格は3年間有効であり、定期的な再認証が求められます。そのため、定期的な自己研鑽が求められます。有効期限切れだと役に立たないのではないかと思われがちです。

*有効期間があるから意味がないと考えずに、その資格取得時にスキルが証明されたという事実は変わらない、という考え方が重要です。*

【参考】：[AWS 再認定](https://aws.amazon.com/jp/certification/recertification/)

### 資格取得に費用と時間がかかる

資格取得には取得費用とかけられる時間を天秤にかけ、「コスパ」や「タイパ」で判断してしまいがちです。短期間での費用対効果という意味合いでは、若手エンジニアが気にすることは十分理解できます。

*その先の5年後10年後にどのような成果をもたらすかを考えると、時間は元に戻らないことも事実です。*この点において、ベテランになる前の受験は将来に繋がる挑戦とも言えます。

## AWSの資格取得の達成による成果

*AWSの資格取得の結果は、多種多様なキャリア選択の可能性が広がります。*自身のスキルアップとしても、希望する仕事を選択するチャンスとしても有効です。

### 資格取得は採用側の要件でも重視される

**クラウドエンジニアなどのクラウド人材は、IT業界のみならず多方面の業種・業態で注目されています。**DX（デジタルトランスフォーメーション）が推進され、利用するIT基盤の中心的な役割を持ちます。

そのため勤務先においても、新規領域としてクラウド活用時に活躍の場が広がります。さらにクラウド人材を求める多くの企業との接点が広がり、より要望に近い職種での活躍の場が得られるでしょう。

クラウド人材は、ITコンサルタントや全体を管理するプロジェクトマネージャーとしても幅広い信頼を得ることができます。

クラウドエンジニアの年収は？求められるスキルや資格を解説！

### 最新の資格に更新することで知識が維持される

AWSに限りませんが、取得資格を活用しどのような成果を得られたのかが重要です。**資格取得はゴールではなく、スタートラインに立つ要素としてスキルアップを継続していきます。**対外的なスキルが常に証明され、新しい可能性が広がります。

即戦力として役立つ証明は能力レベルが基準に達しているのか、その領域の経験を持っているのかで証明できるものです。取得したスキルは、実務を通じても役立つことが増えていくはずです。

### 投資した費用と時間に見合う成果と報酬

**AWSの資格取得により専門性の高い仕事が任され、さらに幅広い領域をカバーする横断的な仕事にも対応できます。**具体的には、新規プロジェクトへの参画や責任ある仕事を担当する機会が増えます。

会社によっては資格取得手当が支給されることもありますし、転職においてはさらに幅広い機会や年収条件などの提示も期待できます。

また、企業のなかには研修制度が整っている場合もあり、未経験から知識をつけながら働くことも可能です。未経験からITエンジニアを目指すなら、自分のスキルにあった企業を探してくれる転職エージェントの活用をおすすめします。

<center>[あなたに合った企業選びをサポート致します。<br/>エンジニア転職のご相談はぜひ<br/>*『マイナビIT エージェント』*へ！](https://mynavi-agent.jp/it/?utm_source=and-engineer&utm_medium=content-text&utm_campaign=acv12_2)</center>

## AWSの資格はDX推進でさらに注目されるスキルです

ここではAWSの資格について触れてきました。AWSの資格取得自体が目標ではなく、その先に目指すキャリアの可能性が広がることが重要な点です。**自身の将来のロードマップを自ら決めることができます。**

将来の達成目標が決まったら、キャリアアップに向けた転職として最適な条件を見つけることも必要です。

AWSはクラウドサービスとして欠かせないものになっています。求められるクラウド人材として、AWS認定資格はスキルを証明するのに有効ですが、資格取得に関して「意味ない」という方もいます。この記事では、実際のところはどうなのか、将来に向けた可能性を考えていきます。

AWSを含むITの資格には、意味があるという声と意味がないという意見がそれぞれあります

IT業界の資格は必須要件ではないために、しばしば「意味ない」論争が起きています

クラウド人材はDXの推進により重要視されており、資格の有効性は将来の可能性を高めます

AWSの資格が「意味ない」は本当？将来はAWSの仕事がなくなる？

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」にマッピングされています。

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

お役立ち記事