Complex classes like Compiler often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Compiler, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
31 | class Compiler extends Validator |
||
32 | { |
||
33 | public static $lastParsed; |
||
34 | |||
35 | /** |
||
36 | * Compile template into PHP code |
||
37 | * |
||
38 | * @param array<string,array|string|integer> $context Current context |
||
39 | * @param string $template handlebars template |
||
40 | * |
||
41 | * @return string|null generated PHP code |
||
42 | */ |
||
43 | 732 | public static function compileTemplate(&$context, $template) { |
|
44 | 732 | array_unshift($context['parsed'], array()); |
|
45 | 732 | Validator::verify($context, $template); |
|
46 | |||
47 | 732 | if (count($context['error'])) { |
|
48 | 75 | return; |
|
49 | } |
||
50 | |||
51 | 658 | Parser::setDelimiter($context); |
|
52 | |||
53 | 658 | $context['compile'] = true; |
|
54 | |||
55 | // Handle dynamic partials |
||
56 | 658 | Partial::handleDynamic($context); |
|
57 | |||
58 | // Do PHP code generation. |
||
59 | 658 | $code = ''; |
|
60 | 658 | foreach ($context['parsed'][0] as $info) { |
|
61 | 658 | if (is_array($info)) { |
|
62 | 617 | $context['tokens']['current']++; |
|
63 | 617 | $code .= "'" . static::compileToken($context, $info) . "'"; |
|
64 | } else { |
||
65 | 658 | $code .= $info; |
|
66 | } |
||
67 | } |
||
68 | |||
69 | 658 | static::$lastParsed = array_shift($context['parsed']); |
|
70 | |||
71 | 658 | return $code; |
|
72 | } |
||
73 | |||
74 | /** |
||
75 | * Compose LightnCandy render codes for include() |
||
76 | * |
||
77 | * @param array<string,array|string|integer> $context Current context |
||
78 | * @param string $code generated PHP code |
||
79 | * |
||
80 | * @return string Composed PHP code |
||
81 | */ |
||
82 | 657 | public static function composePHPRender($context, $code) { |
|
83 | 657 | $flagJStrue = Expression::boolString($context['flags']['jstrue']); |
|
84 | 657 | $flagJSObj = Expression::boolString($context['flags']['jsobj']); |
|
85 | 657 | $flagSPVar = Expression::boolString($context['flags']['spvar']); |
|
86 | 657 | $flagProp = Expression::boolString($context['flags']['prop']); |
|
87 | 657 | $flagMethod = Expression::boolString($context['flags']['method']); |
|
88 | 657 | $flagLambda = Expression::boolString($context['flags']['lambda']); |
|
89 | 657 | $flagMustlok = Expression::boolString($context['flags']['mustlok']); |
|
90 | 657 | $flagMustlam = Expression::boolString($context['flags']['mustlam']); |
|
91 | 657 | $flagEcho = Expression::boolString($context['flags']['echo']); |
|
92 | 657 | $flagPartNC = Expression::boolString($context['flags']['partnc']); |
|
93 | 657 | $flagKnownHlp = Expression::boolString($context['flags']['knohlp']); |
|
94 | |||
95 | 657 | $constants = Exporter::constants($context); |
|
96 | 657 | $helpers = Exporter::helpers($context); |
|
97 | 657 | $partials = implode(",\n", $context['partialCode']); |
|
98 | 657 | $debug = Runtime::DEBUG_ERROR_LOG; |
|
99 | 657 | $use = $context['flags']['standalone'] ? Exporter::runtime($context) : "use {$context['runtime']} as {$context['runtimealias']};"; |
|
100 | 657 | $safeString = (($context['usedFeature']['enc'] > 0) && ($context['flags']['standalone'] === 0)) ? "use {$context['safestring']} as SafeString;" : ''; |
|
101 | 657 | $exportSafeString = (($context['usedFeature']['enc'] > 0) && ($context['flags']['standalone'] >0)) ? Exporter::safestring($context) : ''; |
|
102 | |||
103 | // Return generated PHP code string. |
||
104 | return <<<VAREND |
||
105 | 657 | $safeString{$use}{$exportSafeString}return function (\$in = null, \$options = null) { |
|
106 | 657 | \$helpers = $helpers; |
|
107 | 657 | \$partials = array($partials); |
|
108 | \$cx = array( |
||
109 | 'flags' => array( |
||
110 | 657 | 'jstrue' => $flagJStrue, |
|
111 | 657 | 'jsobj' => $flagJSObj, |
|
112 | 657 | 'spvar' => $flagSPVar, |
|
113 | 657 | 'prop' => $flagProp, |
|
114 | 657 | 'method' => $flagMethod, |
|
115 | 657 | 'lambda' => $flagLambda, |
|
116 | 657 | 'mustlok' => $flagMustlok, |
|
117 | 657 | 'mustlam' => $flagMustlam, |
|
118 | 657 | 'echo' => $flagEcho, |
|
119 | 657 | 'partnc' => $flagPartNC, |
|
120 | 657 | 'knohlp' => $flagKnownHlp, |
|
121 | 657 | 'debug' => isset(\$options['debug']) ? \$options['debug'] : $debug, |
|
122 | ), |
||
123 | 657 | 'constants' => $constants, |
|
124 | 'helpers' => isset(\$options['helpers']) ? array_merge(\$helpers, \$options['helpers']) : \$helpers, |
||
125 | 'partials' => isset(\$options['partials']) ? array_merge(\$partials, \$options['partials']) : \$partials, |
||
126 | 'scopes' => array(), |
||
127 | 'sp_vars' => isset(\$options['data']) ? array_merge(array('root' => \$in), \$options['data']) : array('root' => \$in), |
||
128 | 'blparam' => array(), |
||
129 | 'partialid' => 0, |
||
130 | 657 | 'runtime' => '{$context['runtime']}', |
|
131 | ); |
||
132 | 657 | {$context['renderex']} |
|
133 | 657 | {$context['ops']['op_start']}'$code'{$context['ops']['op_end']} |
|
134 | 657 | }; |
|
135 | VAREND |
||
136 | ; |
||
137 | } |
||
138 | |||
139 | /** |
||
140 | * Get function name for standalone or none standalone template. |
||
141 | * |
||
142 | * @param array<string,array|string|integer> $context Current context of compiler progress. |
||
143 | * @param string $name base function name |
||
144 | * @param string $tag original handlabars tag for debug |
||
145 | * |
||
146 | * @return string compiled Function name |
||
147 | * |
||
148 | * @expect 'LR::test(' when input array('flags' => array('standalone' => 0, 'debug' => 0), 'runtime' => 'Runtime', 'runtimealias' => 'LR'), 'test', '' |
||
149 | * @expect 'LL::test2(' when input array('flags' => array('standalone' => 0, 'debug' => 0), 'runtime' => 'Runtime', 'runtimealias' => 'LL'), 'test2', '' |
||
150 | * @expect "lala_abctest3(" when input array('flags' => array('standalone' => 1, 'debug' => 0), 'runtime' => 'Runtime', 'runtimealias' => 0, 'funcprefix' => 'lala_abc'), 'test3', '' |
||
151 | * @expect 'RR::debug(\'abc\', \'test\', ' when input array('flags' => array('standalone' => 0, 'debug' => 1), 'runtime' => 'Runtime', 'runtimealias' => 'RR', 'funcprefix' => 'haha456'), 'test', 'abc' |
||
152 | */ |
||
153 | 592 | protected static function getFuncName(&$context, $name, $tag) { |
|
166 | |||
167 | /** |
||
168 | * Get string presentation of variables |
||
169 | * |
||
170 | * @param array<string,array|string|integer> $context current compile context |
||
171 | * @param array<array> $vn variable name array. |
||
172 | * @param array<string>|null $blockParams block param list |
||
173 | * |
||
174 | * @return array<string|array> variable names |
||
175 | * |
||
176 | * @expect array('array(array($in),array())', array('this')) when input array('flags'=>array('spvar'=>true)), array(null) |
||
177 | * @expect array('array(array($in,$in),array())', array('this', 'this')) when input array('flags'=>array('spvar'=>true)), array(null, null) |
||
178 | * @expect array('array(array(),array(\'a\'=>$in))', array('this')) when input array('flags'=>array('spvar'=>true)), array('a' => null) |
||
179 | */ |
||
180 | 262 | protected static function getVariableNames(&$context, $vn, $blockParams = null) { |
|
181 | 262 | $vars = array(array(), array()); |
|
182 | 262 | $exps = array(); |
|
183 | 262 | foreach ($vn as $i => $v) { |
|
184 | 224 | $V = static::getVariableNameOrSubExpression($context, $v); |
|
185 | 224 | if (is_string($i)) { |
|
186 | 37 | $vars[1][] = "'$i'=>{$V[0]}"; |
|
187 | } else { |
||
188 | 210 | $vars[0][] = $V[0]; |
|
189 | } |
||
190 | 224 | $exps[] = $V[1]; |
|
191 | } |
||
192 | 262 | $bp = $blockParams ? (',array(' . Expression::listString($blockParams) . ')') : ''; |
|
193 | 262 | return array('array(array(' . implode(',', $vars[0]) . '),array(' . implode(',', $vars[1]) . ")$bp)", $exps); |
|
194 | } |
||
195 | |||
196 | /** |
||
197 | * Get string presentation of a sub expression |
||
198 | * |
||
199 | * @param array<string,array|string|integer> $context current compile context |
||
200 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
201 | * |
||
202 | * @return array<string> code representing passed expression |
||
203 | */ |
||
204 | 41 | public static function compileSubExpression(&$context, $vars) { |
|
213 | |||
214 | /** |
||
215 | * Get string presentation of a subexpression or a variable |
||
216 | * |
||
217 | * @param array<array|string|integer> $context current compile context |
||
218 | * @param array<array|string|integer> $var variable parsed path |
||
219 | * |
||
220 | * @return array<string> variable names |
||
|
|||
221 | */ |
||
222 | 373 | protected static function getVariableNameOrSubExpression(&$context, $var) { |
|
225 | |||
226 | /** |
||
227 | * Get string presentation of a variable |
||
228 | * |
||
229 | * @param array<array|string|integer> $var variable parsed path |
||
230 | * @param array<array|string|integer> $context current compile context |
||
231 | * @param array<string>|null $lookup extra lookup string as valid PHP variable name |
||
232 | * |
||
233 | * @return array<string> variable names |
||
234 | * |
||
235 | * @expect array('$in', 'this') when input array('flags'=>array('spvar'=>true,'debug'=>0)), array(null) |
||
236 | * @expect array('((is_array($in) && isset($in[\'true\'])) ? $in[\'true\'] : null)', '[true]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('true') |
||
237 | * @expect array('((is_array($in) && isset($in[\'false\'])) ? $in[\'false\'] : null)', '[false]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('false') |
||
238 | * @expect array('true', 'true') when input array('flags'=>array('spvar'=>true,'debug'=>0)), array(-1, 'true') |
||
239 | * @expect array('false', 'false') when input array('flags'=>array('spvar'=>true,'debug'=>0)), array(-1, 'false') |
||
240 | * @expect array('((is_array($in) && isset($in[\'2\'])) ? $in[\'2\'] : null)', '[2]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('2') |
||
241 | * @expect array('2', '2') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0)), array(-1, '2') |
||
242 | * @expect array('((is_array($in) && isset($in[\'@index\'])) ? $in[\'@index\'] : null)', '[@index]') when input array('flags'=>array('spvar'=>false,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('@index') |
||
243 | * @expect array("(isset(\$cx['sp_vars']['index']) ? \$cx['sp_vars']['index'] : null)", '@[index]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('@index') |
||
244 | * @expect array("(isset(\$cx['sp_vars']['key']) ? \$cx['sp_vars']['key'] : null)", '@[key]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('@key') |
||
245 | * @expect array("(isset(\$cx['sp_vars']['first']) ? \$cx['sp_vars']['first'] : null)", '@[first]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('@first') |
||
246 | * @expect array("(isset(\$cx['sp_vars']['last']) ? \$cx['sp_vars']['last'] : null)", '@[last]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('@last') |
||
247 | * @expect array('((is_array($in) && isset($in[\'"a"\'])) ? $in[\'"a"\'] : null)', '["a"]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('"a"') |
||
248 | * @expect array('"a"', '"a"') when input array('flags'=>array('spvar'=>true,'debug'=>0)), array(-1, '"a"') |
||
249 | * @expect array('((is_array($in) && isset($in[\'a\'])) ? $in[\'a\'] : null)', '[a]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('a') |
||
250 | * @expect array('((isset($cx[\'scopes\'][count($cx[\'scopes\'])-1]) && is_array($cx[\'scopes\'][count($cx[\'scopes\'])-1]) && isset($cx[\'scopes\'][count($cx[\'scopes\'])-1][\'a\'])) ? $cx[\'scopes\'][count($cx[\'scopes\'])-1][\'a\'] : null)', '../[a]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array(1,'a') |
||
251 | * @expect array('((isset($cx[\'scopes\'][count($cx[\'scopes\'])-3]) && is_array($cx[\'scopes\'][count($cx[\'scopes\'])-3]) && isset($cx[\'scopes\'][count($cx[\'scopes\'])-3][\'a\'])) ? $cx[\'scopes\'][count($cx[\'scopes\'])-3][\'a\'] : null)', '../../../[a]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array(3,'a') |
||
252 | * @expect array('((is_array($in) && isset($in[\'id\'])) ? $in[\'id\'] : null)', 'this.[id]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array(null, 'id') |
||
253 | * @expect array('LR::v($cx, $in, isset($in) ? $in : null, array(\'id\'))', 'this.[id]') when input array('flags'=>array('prop'=>true,'spvar'=>true,'debug'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0,'standalone'=>0), 'runtime' => 'Runtime', 'runtimealias' => 'LR'), array(null, 'id') |
||
254 | */ |
||
255 | 588 | protected static function getVariableName(&$context, $var, $lookup = null, $args = null) { |
|
311 | |||
312 | /** |
||
313 | * Return compiled PHP code for a handlebars token |
||
314 | * |
||
315 | * @param array<string,array|string|integer> $context current compile context |
||
316 | * @param array<string,array|boolean> $info parsed information |
||
317 | * |
||
318 | * @return string Return compiled code segment for the token |
||
319 | */ |
||
320 | 617 | protected static function compileToken(&$context, $info) { |
|
347 | |||
348 | /** |
||
349 | * handle partial |
||
350 | * |
||
351 | * @param array<string,array|string|integer> $context current compile context |
||
352 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
353 | * |
||
354 | * @return string Return compiled code segment for the partial |
||
355 | */ |
||
356 | 88 | public static function partial(&$context, $vars) { |
|
376 | |||
377 | /** |
||
378 | * handle inline partial |
||
379 | * |
||
380 | * @param array<string,array|string|integer> $context current compile context |
||
381 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
382 | * |
||
383 | * @return string Return compiled code segment for the partial |
||
384 | */ |
||
385 | 10 | public static function inline(&$context, $vars) { |
|
396 | |||
397 | /** |
||
398 | * Return compiled PHP code for a handlebars inverted section begin token |
||
399 | * |
||
400 | * @param array<string,array|string|integer> $context current compile context |
||
401 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
402 | * |
||
403 | * @return string Return compiled code segment for the token |
||
404 | */ |
||
405 | 38 | protected static function invertedSection(&$context, $vars) { |
|
409 | |||
410 | /** |
||
411 | * Return compiled PHP code for a handlebars block custom helper begin token |
||
412 | * |
||
413 | * @param array<string,array|string|integer> $context current compile context |
||
414 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
415 | * @param boolean $inverted the logic will be inverted |
||
416 | * |
||
417 | * @return string Return compiled code segment for the token |
||
418 | */ |
||
419 | 60 | protected static function blockCustomHelper(&$context, $vars, $inverted = false) { |
|
428 | |||
429 | /** |
||
430 | * Return compiled PHP code for a handlebars block end token |
||
431 | * |
||
432 | * @param array<string,array|string|integer> $context current compile context |
||
433 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
434 | * @param string|null $matchop should also match to this operator |
||
435 | * |
||
436 | * @return string Return compiled code segment for the token |
||
437 | */ |
||
438 | 321 | protected static function blockEnd(&$context, &$vars, $matchop = NULL) { |
|
474 | |||
475 | /** |
||
476 | * Return compiled PHP code for a handlebars block begin token |
||
477 | * |
||
478 | * @param array<string,array|string|integer> $context current compile context |
||
479 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
480 | * |
||
481 | * @return string Return compiled code segment for the token |
||
482 | */ |
||
483 | 239 | protected static function blockBegin(&$context, $vars) { |
|
503 | |||
504 | /** |
||
505 | * compile {{#foo}} token |
||
506 | * |
||
507 | * @param array<string,array|string|integer> $context current compile context |
||
508 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
509 | * @param boolean $isEach the section is #each |
||
510 | * |
||
511 | * @return string|null Return compiled code segment for the token |
||
512 | */ |
||
513 | 163 | protected static function section(&$context, $vars, $isEach = false) { |
|
531 | |||
532 | /** |
||
533 | * compile {{with}} token |
||
534 | * |
||
535 | * @param array<string,array|string|integer> $context current compile context |
||
536 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
537 | * |
||
538 | * @return string|null Return compiled code segment for the token |
||
539 | */ |
||
540 | 28 | protected static function with(&$context, $vars) { |
|
547 | |||
548 | /** |
||
549 | * Return compiled PHP code for a handlebars custom helper token |
||
550 | * |
||
551 | * @param array<string,array|string|integer> $context current compile context |
||
552 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
553 | * @param boolean $raw is this {{{ token or not |
||
554 | * @param boolean $nosep true to compile without seperator |
||
555 | * |
||
556 | * @return string|null Return compiled code segment for the token when the token is custom helper |
||
557 | */ |
||
558 | 454 | protected static function customHelper(&$context, $vars, $raw, $nosep) { |
|
571 | |||
572 | /** |
||
573 | * Return compiled PHP code for a handlebars else token |
||
574 | * |
||
575 | * @param array<string,array|string|integer> $context current compile context |
||
576 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
577 | * |
||
578 | * @return string Return compiled code segment for the token when the token is else |
||
579 | */ |
||
580 | 50 | protected static function doElse(&$context, $vars) { |
|
590 | |||
591 | /** |
||
592 | * Return compiled PHP code for a handlebars log token |
||
593 | * |
||
594 | * @param array<string,array|string|integer> $context current compile context |
||
595 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
596 | * @param boolean $raw is this {{{ token or not |
||
597 | * |
||
598 | * @return string Return compiled code segment for the token |
||
599 | */ |
||
600 | 2 | protected static function compileLog(&$context, &$vars, $raw) { |
|
605 | |||
606 | /** |
||
607 | * Return compiled PHP code for a handlebars lookup token |
||
608 | * |
||
609 | * @param array<string,array|string|integer> $context current compile context |
||
610 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
611 | * @param boolean $raw is this {{{ token or not |
||
612 | * |
||
613 | * @return string Return compiled code segment for the token |
||
614 | */ |
||
615 | 2 | protected static function compileLookup(&$context, &$vars, $raw) { |
|
624 | |||
625 | /** |
||
626 | * Return compiled PHP code for template output |
||
627 | * |
||
628 | * @param array<string,array|string|integer> $context current compile context |
||
629 | * @param string $variable PHP code for the variable |
||
630 | * @param string $expression normalized handlebars expression |
||
631 | * @param boolean $raw is this {{{ token or not |
||
632 | * @param boolean $nosep true to compile without seperator |
||
633 | * |
||
634 | * @return string Return compiled code segment for the token |
||
635 | */ |
||
636 | 460 | protected static function compileOutput(&$context, $variable, $expression, $raw, $nosep) { |
|
644 | |||
645 | /** |
||
646 | * Return compiled PHP code for a handlebars variable token |
||
647 | * |
||
648 | * @param array<string,array|string|integer> $context current compile context |
||
649 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
650 | * @param boolean $raw is this {{{ token or not |
||
651 | * @param boolean $nosep true to compile without seperator |
||
652 | * |
||
653 | * @return string Return compiled code segment for the token |
||
654 | */ |
||
655 | 359 | protected static function compileVariable(&$context, &$vars, $raw, $nosep) { |
|
664 | |||
665 | /** |
||
666 | * Add usage count to context |
||
667 | * |
||
668 | * @param array<string,array|string|integer> $context current context |
||
669 | * @param string $category category name, can be one of: 'var', 'helpers', 'runtime' |
||
670 | * @param string $name used name |
||
671 | * @param integer $count increment |
||
672 | * |
||
673 | * @expect 1 when input array('usedCount' => array('test' => array())), 'test', 'testname' |
||
674 | * @expect 3 when input array('usedCount' => array('test' => array('testname' => 2))), 'test', 'testname' |
||
675 | * @expect 5 when input array('usedCount' => array('test' => array('testname' => 2))), 'test', 'testname', 3 |
||
676 | */ |
||
677 | 592 | protected static function addUsageCount(&$context, $category, $name, $count = 1) { |
|
683 | } |
||
684 | |||
685 |
This check compares the return type specified in the
@return
annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.