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(Request $request) |
||
| 32 | |||
| 33 | /** |
||
| 34 | * @param Survey $survey |
||
| 35 | * @Route("/survey/{id}", name="survey_get") |
||
| 36 | * @Template("@App/survey.html.twig") |
||
| 37 | * @ParamConverter("survey", class="AppBundle:Survey") |
||
| 38 | */ |
||
| 39 | public function surveyAction(Survey $survey) |
||
| 48 | |||
| 49 | /** |
||
| 50 | * @param Request $request, SurveyType $surveyType |
||
|
|
|||
| 51 | * @Route("/survey/create/{survey_type}", name="survey_create") |
||
| 52 | * @ParamConverter("surveyType", options={"mapping": {"survey_type": "name"}}) |
||
| 53 | */ |
||
| 54 | View Code Duplication | public function surveyCreateAction(Request $request, SurveyType $surveyType) |
|
| 73 | |||
| 74 | /** |
||
| 75 | * @param Request $request, Survey $survey |
||
| 76 | * @Route("/survey/delete/{id}", name="survey_delete") |
||
| 77 | * @ParamConverter("survey", class="AppBundle:Survey") |
||
| 78 | */ |
||
| 79 | View Code Duplication | public function surveyDeleteAction(Request $request, Survey $survey) |
|
| 98 | } |
||
| 99 |
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
$irelandis not defined by the methodfinale(...).The most likely cause is that the parameter was changed, but the annotation was not.