PHP_CodesNiffer cho phép các nhà phát triển thiết kế các tiêu chuẩn mã hóa của riêng họ bằng cách tạo một tệp XML quy tắc đơn giản, cả hai đều thu hơi từ các tiêu chuẩn hiện có và tùy chỉnh chúng cho nhu cầu của nhà phát triển. Tệp XML này có thể được đặt tên bất cứ thứ gì bạn thích, miễn là nó có tiện ích mở rộng xml
và tuân thủ định dạng quy tắc.xml. Tệp có thể được lưu trữ ở bất cứ đâu, làm cho nó hoàn hảo để đặt dưới điều khiển phiên bản với mã nguồn và kiểm tra đơn vị của dự án.
Sau khi được tạo, một tệp quy tắc có thể được sử dụng với đối số dòng lệnh --standard
. Trong ví dụ sau, PHP_CodesNiffer sẽ sử dụng tiêu chuẩn mã hóa được xác định trong tệp quy tắc tùy chỉnh có tên Custom_ruleset.xml:
$ phpcs --standard=/path/to/custom_ruleset.xml test.php
Tệp mẫu được chú thích
Tệp mẫu sau đây ghi lại định dạng quy tắc.xml và hiển thị cho bạn phạm vi đầy đủ các tính năng mà định dạng hỗ trợ. Tệp chỉ được thiết kế cho mục đích tài liệu và không phải là một tiêu chuẩn mã hóa làm việc.
A custom coding standard ./path/to/directory ./path/to/file.php */tests/* */data/* ^/tests/* ^/data/* /path/to/autoload.php /path/to/other/autoload.php ./autoload.php Please review this TODO comment: %s 3 error warning error warning warning Line contains %2$s chars, which is more than the limit of %1$s Line longer than %s characters; contains %s characters 0 0 */tests/* */data/* */tests/* */data/* */templates/* *\.tpl$ */templates/* *\.tpl$
Áp dụng chọn lọc các quy tắc
Tất cả các thẻ trong một tệp quy tắc, ngoại trừ ruleset
và description
, có thể được áp dụng có chọn lọc khi một công cụ cụ thể đang được chạy. Hai công cụ có sẵn là phpcs
[trình kiểm tra tiêu chuẩn mã hóa] và phpcbf
[trình sửa lỗi tiêu chuẩn mã hóa]. Các hạn chế được áp dụng bằng cách sử dụng các thuộc tính thẻ phpcs-only
và
A custom coding standard ./path/to/directory ./path/to/file.php */tests/* */data/* ^/tests/* ^/data/* /path/to/autoload.php /path/to/other/autoload.php ./autoload.php Please review this TODO comment: %s 3 error warning error warning warning Line contains %2$s chars, which is more than the limit of %1$s Line longer than %s characters; contains %s characters 0 0 */tests/* */data/* */tests/* */data/* */templates/* *\.tpl$ */templates/* *\.tpl$0.
Đặt thuộc tính phpcs-only
thành
A custom coding standard ./path/to/directory ./path/to/file.php */tests/* */data/* ^/tests/* ^/data/* /path/to/autoload.php /path/to/other/autoload.php ./autoload.php Please review this TODO comment: %s 3 error warning error warning warning Line contains %2$s chars, which is more than the limit of %1$s Line longer than %s characters; contains %s characters 0 0 */tests/* */data/* */tests/* */data/* */templates/* *\.tpl$ */templates/* *\.tpl$2 sẽ chỉ áp dụng quy tắc khi công cụ
phpcs
đang chạy. Quy tắc sẽ không được áp dụng trong khi tệp đang được sửa bằng công cụ phpcbf
.Đặt thuộc tính
A custom coding standard ./path/to/directory ./path/to/file.php */tests/* */data/* ^/tests/* ^/data/* /path/to/autoload.php /path/to/other/autoload.php ./autoload.php Please review this TODO comment: %s 3 error warning error warning warning Line contains %2$s chars, which is more than the limit of %1$s Line longer than %s characters; contains %s characters 0 0 */tests/* */data/* */tests/* */data/* */templates/* *\.tpl$ */templates/* *\.tpl$0 thành
A custom coding standard ./path/to/directory ./path/to/file.php */tests/* */data/* ^/tests/* ^/data/* /path/to/autoload.php /path/to/other/autoload.php ./autoload.php Please review this TODO comment: %s 3 error warning error warning warning Line contains %2$s chars, which is more than the limit of %1$s Line longer than %s characters; contains %s characters 0 0 */tests/* */data/* */tests/* */data/* */templates/* *\.tpl$ */templates/* *\.tpl$2 sẽ chỉ áp dụng quy tắc khi công cụ
phpcbf
đang sửa một tệp. Quy tắc sẽ không được áp dụng trong khi tệp đang được kiểm tra với công cụ phpcs
.Tệp mẫu sau đây hiển thị tệp Ruleset.xml sử dụng các quy tắc chọn lọc. Tệp chỉ được thiết kế cho mục đích tài liệu và không phải là một tiêu chuẩn mã hóa làm việc.
*/3rdparty/* 0