Thỏa thuận với một dấu gạch dưới hàng đầu trong các phương thức lớp PHP là gì?

Trong khi xem qua các thư viện PHP khác nhau, tôi nhận thấy rằng nhiều người chọn tiền tố một số phương thức lớp với một dấu gạch dưới duy nhất, chẳng hạn như

public function _foo()

...thay vì...

public function foo()

Tôi nhận ra rằng cuối cùng điều này xuất phát từ sở thích cá nhân, nhưng tôi đã tự hỏi liệu có ai có cái nhìn sâu sắc về thói quen này đến từ đâu không.

Tôi nghĩ rằng nó có thể được chuyển sang từ PHP 4, trước khi các phương thức lớp có thể được đánh dấu là được bảo vệ hoặc riêng tư, như một cách ngụ ý "không gọi phương thức này từ bên ngoài lớp". Tuy nhiên, điều đó cũng xảy ra với tôi rằng có lẽ nó bắt nguồn từ đâu đó (một ngôn ngữ) mà tôi không quen thuộc hoặc có thể có lý do chính đáng đằng sau nó mà tôi sẽ được lợi từ việc biết.

Bất kỳ suy nghĩ, hiểu biết và / hoặc ý kiến ​​sẽ được đánh giá cao.

Đó là từ những ngày xưa tồi tệ của PHP hướng đối tượng (PHP 4). Việc triển khai OO đó khá tệ và không bao gồm những thứ như phương pháp riêng tư. Để bù đắp, các nhà phát triển PHP đã đặt trước các phương thức được dự định là riêng tư với dấu gạch dưới. Trong một số lớp học cũ hơn, bạn sẽ thấy /**private*/ __foo() {tăng thêm trọng lượng.

Tôi chưa bao giờ nghe nói về các nhà phát triển mở đầu tất cả các phương thức của họ bằng dấu gạch dưới, vì vậy tôi không thể bắt đầu giải thích nguyên nhân nào.

Tôi tin rằng nguồn có thẩm quyền nhất cho các loại quy ước này cho PHP ngay bây giờ sẽ là Hướng dẫn về Phong cách mã hóa PSR-2 vì Khung công tác Zend là một phần của PSR :

Tên thuộc tính KHÔNG NÊN được tiền tố với một dấu gạch dưới duy nhất để biểu thị khả năng hiển thị được bảo vệ hoặc riêng tư.

Bây giờ, vào năm 2013, đây là phong cách xấu "chính thức" theo hướng dẫn mã hóa PSR-2:

Tên thuộc tính KHÔNG NÊN tiền tố với một dấu gạch dưới duy nhất để biểu thị khả năng hiển thị được bảo vệ hoặc riêng tư`

Nguồn: https://github.com/php-fig/fig-stiterias/blob/master/accepted/PSR-2-coding-style-guide.md

Tôi đã mạnh mẽ chống lại tiền tố các phương thức riêng tư / được bảo vệ bằng dấu gạch dưới vì bạn có thể sử dụng từ khóa riêng tư / được bảo vệ cho điều đó và IDE sẽ đánh dấu nó cho bạn.

Và tôi vẫn vậy, nhưng, tôi đã tìm thấy một lý do tại sao nó có thể là một thực hành tốt. Hãy tưởng tượng rằng bạn có phương thức công khai addFoo()và bên trong phương thức đó bạn có một phần nhiệm vụ chung với các phương thức khác addFooWhenBar(), addFooWhenBaz()... Bây giờ, tên tốt nhất cho phương thức phổ biến đó sẽ là addFoo(), nhưng nó đã được sử dụng, vì vậy bạn phải đưa ra một số Tên xấu như addFooInternal()hoặc addFooCommon()hoặc ... nhưng _addFoo()phương thức riêng tư trông giống như tốt nhất.

Dấu gạch dưới hàng đầu thường được sử dụng cho các thuộc tính và phương thức riêng . Không phải là một kỹ thuật mà tôi thường sử dụng, nhưng vẫn phổ biến trong một số lập trình viên.

Tôi sử dụng một dấu gạch dưới hàng đầu trong lớp PHP 5 tôi viết cho các phương thức riêng tư. Đó là một gợi ý trực quan nhỏ cho nhà phát triển rằng một thành viên lớp cụ thể là riêng tư. Loại gợi ý này không hữu ích khi sử dụng IDE phân biệt các thành viên công cộng và riêng tư cho bạn. Tôi nhặt nó từ những ngày C # của tôi. Thói quen cũ ...

Tôi tin rằng giả định ban đầu của bạn là chính xác, tôi đã thấy đó là thông lệ chung đối với một số ngôn ngữ để thêm tiền tố vào các phương thức / thành viên, v.v. có nghĩa là được giữ riêng tư cho "đối tượng". Chỉ là một cách trực quan để nói mặc dù bạn có thể, bạn không nên gọi đây!

Tôi đang tìm kiếm cùng một câu trả lời, tôi đã thực hiện một số nghiên cứu và tôi vừa phát hiện ra rằng các khung php đề xuất các phong cách khác nhau:

Mã đánh lửa

Hướng dẫn chính thức có phần kiểu mã hóa khuyến khích thực hành này :

Phương thức riêng và biến

Các phương thức và biến chỉ được truy cập nội bộ, chẳng hạn như các hàm tiện ích và trợ giúp mà các phương thức công khai của bạn sử dụng để trừu tượng mã, nên được thêm tiền tố vào dấu gạch dưới.

public function convert_text()

private function _convert_text()

Các khung khác làm tương tự, như

Bánh kem:

làm như vậy :

Tầm nhìn của thành viên

Sử dụng các từ khóa riêng tư và được bảo vệ của PHP5 cho các phương thức và biến. Ngoài ra, tên phương thức hoặc tên biến không công khai bắt đầu bằng một dấu gạch dưới (_). Thí dụ:

class A
{
    protected $_iAmAProtectedVariable;

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

    private $_iAmAPrivateVariable;

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

Và cũng

LÊ

làm như vậy :

Các thành viên lớp tư nhân được đi trước bởi một dấu gạch dưới duy nhất. Ví dụ:

$_status    _sort()     _initTree()

Trong khi

Drupal

kiểu mã đặc biệt cảnh báo chống lại điều này :

9. Các thuộc tính và phương thức được bảo vệ hoặc riêng tư không nên sử dụng tiền tố gạch dưới.

Bản giao hưởng

mặt khác, tuyên bố :

Symfony tuân theo các tiêu chuẩn được xác định trong các tài liệu PSR-0, PSR-1, PSR-2 và PSR-4.

Tôi biết nó từ python, trong đó tiền tố các biến của bạn có dấu gạch dưới khiến trình biên dịch dịch một số chuỗi chữ cái và số ngẫu nhiên trước tên biến thực tế. Điều này có nghĩa là mọi nỗ lực truy cập biến từ bên ngoài lớp sẽ dẫn đến lỗi "biến không xác định".

Tôi không biết nếu đây vẫn là quy ước để sử dụng trong python, mặc dù

Trong Drupal (một php CMS), dấu gạch dưới có thể được sử dụng để ngăn các hook được gọi ( https://api.drupal.org/api/drupal/includes!module.inc/group/hooks/7 ).

Nếu tôi có một mô-đun gọi là "my_module" và muốn đặt tên cho hàm my_module_insert thì nó sẽ "hook" trên hàm hook_insert. Để ngăn chặn điều đó tôi có thể đổi tên hàm của mình thành _my_module_insert.

ps Cách hook hoạt động trong Drupal có thể thực hiện một hook do nhầm lẫn, điều này rất tệ.

Drupal và sử dụng dấu gạch dưới:

Nói chung, dấu gạch dưới là đơn giản để đánh dấu thực tế là một hàm có thể chỉ được gọi bởi một hàm cha có liên quan ...

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>';
}

Tất nhiên, chỉ là một ví dụ đơn giản ...

Sử dụng dấu gạch dưới chỉ để ghi nhớ mục đích mà chúng ta sẽ không 'sửa đổi biến' / 'gọi hàm' bên ngoài lớp.

Khi chúng ta khai báo các biến const trong tất cả các chữ hoa để trong khi nhìn thấy tên của biến có thể đoán rằng đó là một biến const. Tương tự như biến mà chúng tôi không muốn sửa đổi bên ngoài lớp, chúng tôi khai báo nó với dấu gạch dưới cho quy ước riêng của chúng tôi.

Chúng được gọi là "phương pháp ma thuật" .