Menu

[r319]: / trunk / test / good_doc.php  Maximize  Restore  History

Download this file

42 lines (36 with data), 745 Bytes

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
<?php
/**
* This file is an exemple of PHP file containing good style (according to the default ruleset).
*
*/
class GoodTest {
/**
* Correctly documented function.
*
* @param String $a a string
* @param array $b an array
* @param Boolean $c a flag
* @return String a result
*/
function privateFunction($a, array $b = array(), $c = false) {
if ($c > $a) {
return $a + $b;
} else {
return $a;
}
}
/**
* Correctly documented function 2.
*
* The "return" should not count.
*
* @param String $a a string
* @param array $b an array
*/
function privateFunction2($a, array $b = array()) {
if ($b > $a) {
return;
}
// do something else
}
}
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.