PHP类方法中的下划线会如何处理？

在查看各种PHP库时，我注意到很多人选择在某些类方法的前面加一个下划线，例如

public function _foo()

...代替...

public function foo()

我意识到这最终归结于个人喜好，但我想知道是否有人对这种习惯的来源有所了解。

我的想法是，它可能是从PHP 4继承过来的，然后才可以将类方法标记为受保护或私有，以暗示“不要从类外部调用此方法”。但是，我也想到它可能起源于我不熟悉的某个地方（一种语言），或者背后隐藏着很好的理由，我将从了解中受益。

任何想法，见解和/或意见将不胜感激。

它来自于面向对象的PHP（PHP 4）的糟糕年代。OO的实现非常糟糕，并且不包含私有方法之类的东西。为了弥补这一点，PHP开发人员在方法的开头加了下划线，这些方法原本是私有的。在一些较旧的课程中，您会看到/**private*/ __foo() {它增加一些重量。

我从来没有听说过开发人员在所有方法前都加下划线，因此我无法开始解释造成这种情况的原因。

我认为，目前这些PHP约定最权威的来源是PSR-2：编码样式指南，因为Zend框架是PSR的一部分：

属性名称不应以单个下划线作为前缀，以表示受保护的或私有的可见性。

现在，在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()or 这样的丑陋名称，但是_addFoo()私有方法看起来是最好的方法。

前导下划线通常用于私有属性和方法。这不是我通常使用的技术，但在某些程序员中仍然很流行。

我在为私有方法编写的PHP 5类中使用领先的下划线。对于开发人员来说，特定类成员是私有的只是一个小的视觉提示。当使用可为您区分公共成员和私有成员的IDE时，这种类型的提示没有用。我从C＃的日子里捡起它。旧习惯...

我相信您最初的假设是正确的，我发现某些语言在方法/成员等下加下划线是一种普遍的做法，这些方法/成员等应对“对象”保密。尽管可以，但只是一种视觉方式，您不应该这样称呼！

我一直在寻找相同的答案，我做了一些研究，但我发现php框架建议使用不同的样式：

代码点火器

官方手册的编码风格部分鼓励这种做法：

私有方法和变量

仅在内部访问的方法和变量（例如，公用方法用于代码抽象的实用工具和帮助器函数）应带有下划线前缀。

public function convert_text()

private function _convert_text()

其他框架也一样，例如

Cakephp：

做同样的事情：

成员可见度

将PHP5的private和protected关键字用于方法和变量。此外，非公共方法或变量名称以单个下划线（_）开头。例：

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变量。与我们不想在类外部修改的变量类似，我们为自己的约定在下划线处声明了该变量。

它们被称为“魔术方法”。