This product is not supported for your selected Datadog site. ().
이 페이지는 아직 영어로 제공되지 않습니다. 번역 작업 중입니다. 현재 번역 프로젝트에 대한 질문이나 피드백이 있으신 경우 언제든지 연락주시기 바랍니다.
Metadata
ID:php-code-style/short-method-name
Language: PHP
Severity: Notice
Category: Code Style
Description
This rule emphasizes the importance of avoiding short method names in your PHP code. Short method names such as ‘a’ or ‘b’ provide little to no context about what the function does, making it harder for others and yourself to understand the code. This can lead to confusion, misinterpretation, and mistakes during code maintenance or enhancement.
The importance of this rule lies in the clarity and maintainability of your code. Clear, descriptive method names make it easier to understand the function’s purpose without needing to read and understand its internal implementation. This not only improves readability, but also reduces the time needed to understand the code, making it more efficient to work with.
To avoid this, always use meaningful, descriptive names for your methods. Good method names should accurately represent what the method does. For example, a method that calculates the total price could be named calculateTotalPrice(). By following this practice, you contribute to creating clean, understandable, and maintainable code.
Non-Compliant Code Examples
<?phpfunctiona(){}classFoo{functionb(){}}
Compliant Code Examples
<?phpfunctionfoo(){}classFoo{functionbar(){}}
원활한 통합. Datadog Code Security를 경험해 보세요
Datadog Code Security
이 규칙을 사용해 Datadog Code Security로 코드를 분석하세요
규칙 사용 방법
1
2
rulesets:- php-code-style # Rules to enforce PHP code style.
리포지토리 루트에 위의 내용을 포함하는 static-analysis.datadog.yml을 만듭니다
무료 IDE 플러그인을 사용하거나 CI 파이프라인에 Code Security 검사를 추가합니다