| ↑ Документирование PHP-кода | ||||
| Урок 3. Теги в phpDocumentor |
||||
| ← | Предыдущий урок 2. Создание документации |
Следующий урок → 4. phpDocumentor - генератор документации
|
||
**** - *** ***************** *****, ************* *** ********** ************ PHPDoc-***********.
*********** *** **** *****:
- ******* ****.
- ******** (inline) ****.
****** **** **** * ****** ****** * ***** ********* ***:
@<***> <********>
- <***> - *** **** (**** ** *****************)
- <********> - ********* *********** * ****
********:
/**
* @param string $login ***** ************
*/
**** ******** ****** ******** *****:
- @author - ********* ******.
- @version - ********* ****** *****. ***** *************.
- @package - ********* *** *****.
- @subpackage - ********* *** *********.
- @var - ********* ******** * ********** *** ******** ******.
- @param - ********* ******** ******* *** ******
- @return - ********* ******** ************ ********
- @todo - *******, * ******* ********* ****
******** (inline) **** ************ ****** ********** * ****** *********** * {} (******** ******):
/**
* *** ******** *** {@source 3}.
*/
*** @author
/**
* @author *********
* @author ******* <gandy@site.zzz>
*/
*** @version
/**
* @version $Id$
*/
*** @package * @subpackage
*** @package * @subpackage ************ *** ******** ********* *******:
/**
* @package *******
* @package **********
*/
*** @var
*** @var ********* ******** * ********** *** ******** ******. ******** * **** @var ************ *** ************** * IDE.
/**
* @var <*** **********> <********>
*/
******:
/**
* @var classUser ********, ********* ******
*/
$acount = null;
*** @param
*** @param ********* ******** * ********** ******* * ******* *******. ******** * **** @param ************ *** ************** * IDE.
/**
* @param <*** **********> $***_********* <********>
*/
******:
/**
* @param classUser $user ************ *********** ******
* @param int $sum ***** **********
*/
public function add(classUser $user, $sum){}
*** @return
*** @return ********* ******** * ************* ******** * ******** * ******* *******.
/**
* @return <*** **********>
*/
******:
/**
* @return bool ********* ******.
*/
public function add(classUser $user, $sum){
return TRUE;
}
*** @todo
*** @todo ********* *******, * ******* ********* ****. ********* IDE ********* ************* **** *** ***** *********.
/**
* @todo <****** ** *******>
*/
******:
/**
* @todo ******** *********** ******** ************ ***** ID
*/
public function add(classUser $user, $sum){
return TRUE;
}
| ↑ Документирование PHP-кода | ||||
| Урок 3. Теги в phpDocumentor |
||||
| ← | Предыдущий урок 2. Создание документации |
Следующий урок → 4. phpDocumentor - генератор документации
|
||