Documentatie (PHPDoc)
Ik verwacht de komende paar jaren niet samen te werken met 'buitenlandse' programmeurs, eigenlijk nooit.
Het zou erg fijn zijn als je hier een stukje documentatie kan laten zien hoe jij het aanpakt.
Gewijzigd op 12/10/2011 19:56:42 door Aad B
Toch besloten om alles Engelstalig te gaan doen!
EDIT: Toch maar even iets van code posten dan, deze kleine pagina heb ik net opnieuw gedocumenteerd:
Code (php)
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
43
44
45
46
47
48
49
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
43
44
45
46
47
48
49
<?php
/**
* @author ...
* @package ...
* @name Dashboard
*/
class Dashboard extends CI_Controller
{
/**
* @name __construct
* @access public
*
* Run the main controller in the framework and check if the user can access this page.
*/
function __construct()
{
parent::__construct();
$this->permission->check();
}
/**
* @name index
* @access public
* @return view
*
* Say hello to the user and show the login history for this user.
*/
function index()
{
$data['pageName'] = 'Dashboard';
$data['loginHistory'] = $this->dashboard_model->loginHistory();
$this->load->view('dashboard/index', $data);
}
/**
* @name logout
* @access public
* @return redirect
*
* Delete the user session and redirect the user to the index (loginpage).
*/
function logout()
{
$this->session->sess_destroy();
redirect('');
}
}
/**
* @author ...
* @package ...
* @name Dashboard
*/
class Dashboard extends CI_Controller
{
/**
* @name __construct
* @access public
*
* Run the main controller in the framework and check if the user can access this page.
*/
function __construct()
{
parent::__construct();
$this->permission->check();
}
/**
* @name index
* @access public
* @return view
*
* Say hello to the user and show the login history for this user.
*/
function index()
{
$data['pageName'] = 'Dashboard';
$data['loginHistory'] = $this->dashboard_model->loginHistory();
$this->load->view('dashboard/index', $data);
}
/**
* @name logout
* @access public
* @return redirect
*
* Delete the user session and redirect the user to the index (loginpage).
*/
function logout()
{
$this->session->sess_destroy();
redirect('');
}
}
Gewijzigd op 20/10/2011 20:17:24 door PHP Scripter
Dus:
Code (php)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<?php
/** Titel
*
* Beschrijving
* Beschrijving
* Beschrijving
*
* @return bool Success
*/
/** Titel zonder beschrijving
*
* @return bool Success
*/
?>
/** Titel
*
* Beschrijving
* Beschrijving
* Beschrijving
*
* @return bool Success
*/
/** Titel zonder beschrijving
*
* @return bool Success
*/
?>
Praktijkvoorbeeld:
Code (php)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<?php
/** Error handler
*
* Will be triggered when an error occures. This function shows where what error occured, and echoes a stacktrace.
* When triggered, the script shuts down.
*
* @access public
* @param int $type Error-type, predifined PHP-constant.
* @param string $error Description of the error.
* @param string $errFile Path of the file where the error occured.
* @param int $errLine The line where the error occured.
* @param array $context Some for the error relevant variables.
* @return void
*/
?>
/** Error handler
*
* Will be triggered when an error occures. This function shows where what error occured, and echoes a stacktrace.
* When triggered, the script shuts down.
*
* @access public
* @param int $type Error-type, predifined PHP-constant.
* @param string $error Description of the error.
* @param string $errFile Path of the file where the error occured.
* @param int $errLine The line where the error occured.
* @param array $context Some for the error relevant variables.
* @return void
*/
?>
Code (php)
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
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
<?php
/**
* @author ...
* @package ...
* @name Dashboard
*/
class Dashboard extends CI_Controller
{
/** constructor
*
* Run the main controller in the framework and check if the user can access this page.
*
* @access public
*/
function __construct() { }
/** index
*
* Say hello to the user and show the login history for this user.
*
* @access public
* @return view
*/
function index() { }
/** logout
*
* Delete the user session and redirect the user to the index (loginpage).
*
* @access public
* @return redirect
*/
function logout() { }
}
/**
* @author ...
* @package ...
* @name Dashboard
*/
class Dashboard extends CI_Controller
{
/** constructor
*
* Run the main controller in the framework and check if the user can access this page.
*
* @access public
*/
function __construct() { }
/** index
*
* Say hello to the user and show the login history for this user.
*
* @access public
* @return view
*/
function index() { }
/** logout
*
* Delete the user session and redirect the user to the index (loginpage).
*
* @access public
* @return redirect
*/
function logout() { }
}
Gewijzigd op 20/10/2011 20:52:36 door PHP Scripter
@return [type] [description]
Bijvoorbeeld:
@return bool Success
