php 有下划线的方法,关于编码风格：PHP类方法中领先的下划线有什么用？

心已赠人 2022-11-17 10:27 123阅读 0赞

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

public function \_foo()

…而不是…

public function foo()

我意识到这最终取决于个人喜好，但我想知道是否有人对这个习惯的来源有一些了解。

我的想法是，在类方法被标记为受保护或私有之前，它可能是从php 4继承的，作为一种暗示"不要从类外部调用此方法"的方法。然而，我也想到，它可能起源于我不熟悉的某个地方(一种语言)，或者它背后可能有很好的推理，我会从中受益。

任何想法、见解和/或意见都会受到赞赏。

更新2014：官方过时语法：github.com/php fig/fig standards/blob/master/accepted/&hellip；

它来自于面向对象的PHP(php 4)过去的糟糕时期。OO的实现非常糟糕，没有包括私有方法等内容。为了弥补这个不足，PHP开发人员用下划线作为私有方法的序言。在一些老的课程中，你会看到/\*\*private\*/ \_\_foo() \{给它额外的重量。

我从未听说过开发人员在所有方法的开头都加了下划线，所以我无法解释是什么导致了这种情况。

我在我的控制器中的方法之前放置一个下划线，这些方法对类是私有的，在路由中是未使用的。因为我使用自己的框架，这增加了安全性，因为我执行了路由中控制器名称不带前导下划线的策略。但这很少超过每个控制器1-2个方法。

按照惯例，使用Perl时，以下划线开头的方法是私有的。但这只是一个惯例。实际上，这些方法仍然可以从类外部访问。

如果扩展类决定将其父级的受保护方法公开，则下划线的意义就更小了。这是一个边缘案例，但它确实发生了。API开发人员还可以选择将私有方法公开为公共方法，这意味着除了更改访问修饰符之外，他们还必须重构方法名。没什么大不了的，不过还是很麻烦。

Johan-重构很麻烦？我的编辑器有一个称为"查找和替换"的功能。工作很棒！

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

Property names SHOULD NOT be prefixed with a single underscore to indicate protected or private visibility.

我认为，使用命名约定并不是热爱一门语言的理由。

当我第一次读到这篇文章时，我理解了这样做的原因，这样您就可以查看一个方法，并知道它是公共的还是私有的。如果这是一个要求，而不是一个惯例的话，那就更有意义了。因为如果一个团队中有一个程序员在不需要的地方添加了一个下划线，或者用一个下划线公开了一个下划线，那么最终会出现很多混乱。事实证明，正如杰里米指出的，这是来自php4的，基于pear约定，zf的约定。Pear已经移除了它，我相信ZF也会效仿。

这个答案是正确的。它在马根托到处都是，正如下面的sliq所指出的，这是一个通常被否决的惯例。

以下是有关此的更新链接。framework.zend.com/manual/1.12/en/&hellip；

FYI(和@Joedvon)Zend 2.4几个月前发布，他们仍然使用下划线作为私有和受保护的框架。zend.com/manual/current/en/ref/&hellip；。

但是现在Zend框架版本2.4在代码中不使用带有protected和private变量或方法声明的前缀单下划线。例如：AbstractActionControllerclass->github.com/zendframework/zend mvc/blob/master/src/controller&zwnj；&；/&hellip；或AbstractControllerclass->github.com/zendframework/zend mvc/blob/master/src/controller&zwnj；&；/&hellip；

现在，在2013年，根据PSR-2编码准则，这是"官方"的坏样式：

Property names SHOULD NOT be prefixed with a single underscore to indicate protected or private visibility\`

来源：https://github.com/php-fig/fig-standards/blob/master/accepted/psr-2-coding-style-guide.md

根据PSR-2->"不应"指"不推荐"不禁止，这意味着在某些情况下可以接受。psr文档->ietf.org/rfc/rfc2119.txt

我强烈反对在private/protected方法前加下划线，因为您可以使用private/protected关键字，IDE会为您标记它。

我仍然是，但是，我发现了一个原因，为什么它可以成为一个好的实践。假设您有一个公共方法addFoo()，在这个方法中，您有一部分任务是与其他方法addFooWhenBar()、addFooWhenBaz()相同的。现在，这个常用方法的最佳名称是addFoo()，但它已经被采用了，所以您必须想出一些难听的名称，如addFooInternal()、addFooCommon()或…但\_addFoo()私有方法看起来是最好的方法。

是的，同意了。实际上，我来这里是想看看其他人对下划线的看法，因为我很少使用它们，而且总是感觉不对劲，但这个例子是我的一次。我还将它们用于模板方法模式的某些情况，其中公共方法调用子级已重写的抽象保护方法，这是一个类似的想法。有时，公共方法和它调用的抽象保护方法是如此相似或相关，以至于以不同的方式命名它们似乎比在抽象方法之前加前缀更奇怪。

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

我在为私有方法编写的php 5类中使用了前导下划线。对于开发人员来说，这是一个很小的视觉提示，即特定的类成员是私有的。当使用为您区分公共和私有成员的IDE时，这种提示就没有那么有用了。我是从我的购物日里买的。旧习惯…

我相信你最初的假设是正确的，我发现有些语言在方法/成员等前面加上下划线是很常见的做法，这些方法/成员等都是对"对象"保密的。只是一种直观的表达方式，尽管你可以，但你不应该这么说！

我在寻找相同的答案，我做了一些研究，我刚刚发现PHP框架建议不同的风格：

编码点火器

官方手册有一个编码样式部分，鼓励这种做法：

Private Methods and Variables

Methods and variables that are only accessed internally, such as utility and helper functions that your public methods use for code abstraction, should be prefixed with an underscore.

public function convert\_text()

private function \_convert\_text()

其他框架也一样，比如

Cakephp：

做同样的事情：

Member Visibility

Use PHP5’s private and protected keywords for methods and variables. Additionally, non-public method or variable names start with a single underscore (\_). Example:

class A

protected $\_iAmAProtectedVariable;

protected function \_iAmAProtectedMethod()

/\* ... \*/

private $\_iAmAPrivateVariable;

private function \_iAmAPrivateMethod()

/\* ... \*/

而且

梨

做同样的事情：

Private class members are preceded by a single underscore. For example:

$\_status    \_sort()     \_initTree()