Softonic

PHP スニペットを整える

ステップ 1 / 2
次へ

読みにくいスニペットは回答が集まりにくくなります。ここにコードを貼り付けると、1行1文とそろったインデントになります。そのあと、チケット、チャットメッセージ、フォーラムの質問、ドキュメントにコピーしてください。数秒で終わり、短いサンプルに向いています。

共有用にスニペットを準備する方法

  1. 1

    まずコードを絞る

    質問と無関係な部分を削除し、パスワード、キー、実名はダミーの値に置き換えます。

  2. 2

    貼り付ける

    絞ったスニペットを PHP コードの欄に貼り付け、2 スペースか 4 スペースを選びます。

  3. 3

    結果へ進む

    整形後のバージョンを開きます。

  4. 4

    コピーして投稿する

    元のコードと見比べてから、投稿先のコードブロックに貼り付けます。

整形が読み手の助けになる理由

人はコードを形で読み取ります。かっこがそろい、文ごとに行が分かれていれば、読み手は一語を読む前に構造をつかめます。レビューする人も、閉じかっこの抜けや、ずれたループをすぐに見つけられます。改行のないテキストの塊では、それが隠れてしまいます。

整形前と整形後

元のコード（ログからコピーしたもの）:

<?php function total($items){$sum=0;foreach($items as $item){$sum+=$item["price"];}return $sum;}

4 スペースで整えた後:

<?php function total($items)
{
    $sum=0;
    foreach($items as $item)
    {
        $sum+=$item["price"];
    }
    return $sum;
}

投稿前のチェックリスト

  • 秘密情報を削除してください。ここに貼り付けたテキストはサーバーで処理されるため、実際の認証情報、トークン、顧客データは使わないでください。
  • 問題を示すのに必要な行だけを残し、例を最小限にしてください。
  • 使っている PHP のバージョンと、期待していた動作を書いてください。
  • 整形後のコードを元のコードと比べてください。この tool が変えるのはレイアウトだけですが、空白のルールによってコメントや文字列に影響が出る場合があります。
  • インデントが崩れないように、結果をコードブロックで囲んでください。

このツールでできないこと

エラーの検出、コードの実行、スタイルルールのチェックは行いません。きれいなレイアウトは問題を見つけやすくしますが、問題そのものを直すわけではありません。

役立つ場面

  • コードのサンプルを含むサポートチケットやバグ報告。
  • 開発者向けフォーラムやチャットチャンネルでの質問。
  • 例が見やすく整っている必要がある、ドキュメントやチュートリアルのページ。
  • 関数の一部を変更する提案をするレビューコメント。

どの場合も、読み手は問題より先に構造を見ることができます。これが望ましい順番です。

スニペットを正直に保つ

清書版ではなく、実際に投稿するコードを整形してください。例を収めるために変数名を短くしたり行を削ったりした場合は、まず短くしたバージョンを自分で実行してください。問題を再現しないきれいなスニペットは、読み手の時間を無駄にします。予想される結果について補足を書く場合は、コードブロックの上に平易な言葉で書いてください。

よくある質問

いいえ。先にパスワード、キー、個人データをダミーの値に置き換えてください。貼り付けたテキストは整形のためにサーバーへ送信されます。

通常のコードであれば変わるのは空白だけです。ただし、コメント、heredoc、カンマを含む文字列は変更される場合があるため、出力を元のコードと比べてください。

いいえ。構文のチェックもスニペットの実行もしません。コードのレイアウトを見やすくするだけです。

この tool は短いスニペット向けです。長いファイルには、エディタで設定したフォーマッタの方が適しています。

関連ツール

Webpack設定ジェネレーター

素の JavaScript、React、Vue 向けに webpack 5 の webpack.config.js を生成します。TypeScript、Babel、CSS や Sass、画像、HtmlWebpackPlugin、開発サーバー、npm install のコマンドまでそろいます。

カラーティントジェネレーター

ベースカラーの明るい色合いを生成します。デザイン システム トークン、背景、ホバー状態を 3 ～ 20 段階でスケールします。

CMYK から RGB への変換

標準的な計算式で CMYK の割合をおおよその RGB 値と Hex 値に変換し、画面用にすばやく確認できます。

.gitignore ジェネレーター

Laravel、Node.js、Python、Rails のプロジェクト用除外ルールを組み合わせます。結果をコピーするか、.gitignore 入りの ZIP をダウンロードできます。個人用ルールは別に表示します。

16進数から10進数への変換ツール

16進数を10進数（10進法）に変換します。メモリアドレス、エラーコード、RGBチャンネル、任意精度の整数に対応します。

JSONからPythonデータクラスへの変換

JSONから、型ヒント、オプションフィールド、ネストされたクラス、およびdataclasses-jsonまたはPydanticサポートを備えたPythonデータクラスを生成します。

このツールは他の言語でも利用できます

使い方ガイドと活用例