Missing function/class method doc comment PHP-D1002
Documentation
Minor
a year ago
—
a year old
Doc comment missing for function
main20}
21
22
23function main() {24
25 $p = generatePrimes(1000000);
26 return $p[10000];Doc comment missing for function
generatePrimes 1<?php
2function generatePrimes($MAX_SIZE){ 3 $primes = [];
4 $IsPrime = array_fill(0, $MAX_SIZE, TRUE);
5 for ($p = 2; $p * $p < $MAX_SIZE; $p++) {Doc comment missing for function
main 1<?php
2function main() { 3 $total = 0;
4 $total2 = 0;
5 for ($i = 1; $i <= 100; $i++) {Doc comment missing for function
main 8 return $a;
9}
10
11function main() {12 $count = 1;
13 for ($i = 1; $i <= 20; $i++) {
14 $count *= floor($i / gcd($i, $count));Doc comment missing for function
gcd 1<?php
2function gcd($a, $b) { 3 while ($b != 0) {
4 $c = $a % $b;
5 $a = $b;
Description
Documentation comments are helpful in understanding what that part of the code is responsible for. It is always a good idea to add documentation to your code to improve the code readability and maintainability. In addition to that, it becomes helpful when you revisit the code after a long time. Here, the function/class method is missing the doc comment and it is recommended to add it for the reasons discussed above.