PHPクラスメソッドの主要なアンダースコアとの取り決めは何ですか？

さまざまなPHPライブラリを調べていると、多くの人がいくつかのクラスメソッドの前に単一の下線を付けることを選択していることに気付きました。

public function _foo()

...の代わりに...

public function foo()

これは最終的に個人の好みに帰着することはわかっていますが、この習慣がどこから来ているのかについて誰かが洞察を持っているのではないかと思っていました。

「クラスの外部からこのメソッドを呼び出さない」ことを暗示する方法として、クラスメソッドが保護またはプライベートとしてマークされる前に、おそらくPHP 4から引き継がれていると思います。しかし、それはおそらく、私がよく知らないどこか（言語）で発生したことや、その背後にあることを知っておくとよい理由があるかもしれないということにも気付きました。

どんな考え、洞察、および/または意見もいただければ幸いです。

これは、オブジェクト指向PHP（PHP 4）の古き良き時代のものです。そのOOの実装はかなり悪かったため、プライベートメソッドなどは含まれていませんでした。これを補うために、PHP開発者は、アンダースコアを使用して非公開にすることを目的としたメソッドを前置きしました。いくつかの古いクラスでは/**private*/ __foo() {、いくつかの追加の重みを与えることがわかります。

開発者がすべてのメソッドの前にアンダースコアを付けるのを聞いたことがないので、その原因を説明することはできません。

Zend FrameworkはPSRの一部であるため、現時点でのPHPのこれらの種類の規則の最も信頼できるソースは、PSR-2：Coding Style Guideであると考えています。

保護された、またはプライベートな可視性を示すために、プロパティ名の前に単一の下線を付けることはできません。

さて、2013年には、これはPSR-2コーディングガイドラインによる「公式に」悪いスタイルです。

プロパティ名には、保護またはプライベートの可視性を示すために、単一のアンダースコアをプレフィックスとして付けないでください `

ソース：https : //github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md

プライベート/保護されたメソッドの前にアンダースコアを付けることには強く反対しました。プライベート/保護されたキーワードを使用でき、IDEがマークを付けてくれるからです。

そして、私はまだですが、良い実践になり得る理由を見つけました。あなたが公共のメソッドを持っていることを想像addFoo()し、そのメソッド内で使用すると、他の方法と共通であるタスクの一部を持ってaddFooWhenBar()、addFooWhenBaz()今...、その一般的な方法のための最高の名前は次のようになりますaddFoo()が、あなたは、いくつかを考え出す必要がありますので、それはすでに、取られますaddFooInternal()or addFooCommon()または...のような醜い名前ですが、_addFoo()privateメソッドは最適な方法のように見えます。

先頭のアンダースコアは通常、プライベートプロパティとメソッドに使用されます。私が通常採用している手法ではありませんが、一部のプログラマーの間で人気を保っています。

私は、プライベートメソッド用に記述したPHP 5クラスで先頭のアンダースコアを使用しています。特定のクラスメンバーがプライベートであることは、開発者にとって小さな視覚的な手掛かりです。このタイプのヒントは、パブリックメンバーとプライベートメンバーを区別するIDEを使用する場合にはそれほど役に立ちません。私はC＃日からそれを拾いました。古い習慣...

あなたの元の仮定は正しかったと思います。一部の言語では、「オブジェクト」に対して非公開にしておくことを意図したメソッド/メンバーなどにアンダースコアを付けるのが一般的であることがわかりました。視覚的に言うことはできますが、これを呼ぶべきではありません！

私は同じ答えを探していました、私はいくつかの研究をしました、そして私はphpフレームワークが異なるスタイルを示唆していることを発見しました：

コードイグナイター

公式マニュアルには、この習慣を奨励するコーディングスタイルセクションがあります。

プライベートメソッドと変数

パブリックメソッドがコードの抽象化に使用するユーティリティやヘルパー関数など、内部でのみアクセスされるメソッドと変数の前には、アンダースコアを付ける必要があります。

public function convert_text()

private function _convert_text()

他のフレームワークも同様です

Cakephp：

同じことをします：

メンバーの可視性

メソッドと変数には、PHP5のプライベートおよび保護されたキーワードを使用します。さらに、非パブリックメソッドまたは変数名は、単一の下線（_）で始まります。例：

class A
{
    protected $_iAmAProtectedVariable;

    protected function _iAmAProtectedMethod()
    {
       /* ... */
    }

    private $_iAmAPrivateVariable;

    private function _iAmAPrivateMethod()
    {
        /* ... */
    }
}

そしてまた

梨

同じことをします：

プライベートクラスメンバーの前には、単一の下線が付いています。例えば：

$_status    _sort()     _initTree()

ながら

Drupal

コードスタイルは特にこれに対して警告します：

9. 保護されたプロパティまたはプライベートプロパティとメソッドでは、アンダースコアプレフィックスを使用しないでください。

交響曲

一方、宣言します：

symfonyはPSR-0、PSR-1、PSR-2およびPSR-4ドキュメントで定義された標準に従います。

私はそれをpythonから知っていますが、アンダースコアを変数の前に付けると、コンパイラは実際の変数名の前にランダムな文字と数字のシーケンスを変換します。つまり、クラスの外部から変数にアクセスしようとすると、「変数が未定義」エラーが発生します。

これがまだPythonで使用する慣習であるかどうかはわかりませんが、

Drupal（php CMS）では、下線を使用してフックが呼び出されないようにすることができます（https://api.drupal.org/api/drupal/includes!module.inc/group/hooks/7）。

「my_module」というモジュールがあり、関数にmy_module_insertという名前を付けたい場合は、関数hook_insertを「フック」します。これを防ぐには、関数の名前を_my_module_insertに変更します。

ps Drupalでフックが機能する方法は、誤ってフックを実装する可能性があり、これは非常に悪いことです。

Drupal、およびアンダースコアの使用：

一般的に、アンダースコアは、関数がおそらく関連する親関数によってのみ呼び出されるという事実を単純にマークすることです...

function mymodule_tool($sting="page title"){
    $out ='';
    //do stuff 
    $out  .= _mymodule_tool_decor($sting);
    return $out;
}

function _mymodule_tool_decor($sting){
    return '<h1>'.$string.'</h1>';
}

もちろん、単なる例です...

クラスの外で「変数を変更する」/「関数を呼び出す」ことはしないという目的を覚えておくためだけにアンダースコアを使用します。

const変数をすべて大文字で宣言しているので、変数の名前を見ながら、それがconst変数であると推測できます。クラスの外で変更したくない変数と同様に、独自の規則のためにアンダースコアで宣言します。

それらは"マジックメソッド"と呼ばれます。