Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
1 | <?php |
||
14 | class SurveyController extends Controller |
||
15 | { |
||
16 | /** |
||
17 | * @Route("/surveys", name="surveys") |
||
18 | * @Template("@App/surveys.html.twig") |
||
19 | */ |
||
20 | public function surveysAction() |
||
30 | |||
31 | /** |
||
32 | * @param Survey $survey |
||
33 | * @Route("/survey/{id}", name="survey_get") |
||
34 | * @Template("@App/survey.html.twig") |
||
35 | * @ParamConverter("survey", class="AppBundle:Survey") |
||
36 | */ |
||
37 | public function surveyAction(Survey $survey) |
||
46 | |||
47 | /** |
||
48 | * @param Request $request, SurveyType $surveyType |
||
|
|||
49 | * @Route("/survey/create/{survey_type}", name="survey_create") |
||
50 | * @ParamConverter("surveyType", options={"mapping": {"survey_type": "name"}}) |
||
51 | */ |
||
52 | View Code Duplication | public function surveyCreateAction(Request $request, SurveyType $surveyType) |
|
71 | |||
72 | /** |
||
73 | * @param Request $request, Survey $survey |
||
74 | * @Route("/survey/delete/{id}", name="survey_delete") |
||
75 | * @ParamConverter("survey", class="AppBundle:Survey") |
||
76 | */ |
||
77 | View Code Duplication | public function surveyDeleteAction(Request $request, Survey $survey) |
|
96 | } |
||
97 |
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit.
Consider the following example. The parameter
$ireland
is not defined by the methodfinale(...)
.The most likely cause is that the parameter was changed, but the annotation was not.