Материалы

SEO
Железо
Сети
Интернет
CSS
HTML
PHP
JavaScript
AJAX
MySQL
Apache
FAQ
Windows
Linux
Дизайн
Программирование
Безопасность

[:NetFAQ://]

Поиск

[:NetFAQ://]

Партнеры

[:NetFAQ://]

Реклама

ремонт гбц

[:NetFAQ://]

Генерируем документацию для php скрипта.

Частенько возникает потребность в документировании собственного или чужого творения, притом если производить все манипуляции "ручками" то убъётся слишком много времени и сил, что делать, как быть? Об этом и пойдёт речь в данной статье.

На помощь приходит проект phpDocumentator http://www.phpdoc.org
Теперь ты сможешь быстро создать структурированный справочник, описывающий к примеру все методы твоего класса.
Что бы установить сию полезную вещь, выходим в консоль и пишем:


C:\> pear install phpDocumentator

Если нет pear, установите его.
Едем дальше. Вкраце опишу принцип работы данной системы. phpDOC парсит твой скрипт, и ищет специальные тэги-разметки, здесь я приведу самые ходовые, остальные смотрим на официальном сайте:

/**	<- так начинается любой комментарий для phpDOC.
@author	<- после данной вставки идёт имя автора.
@copyright	<- копирайт.
@license	<- лицензия.
@see	<- перекрётсный вызов метода из другого класа. Текст который идёт после этого тэга, является названием класса или метода, на который ссылаются.
@param	<- после данного тэга идёт параметр который принимает функция а затем его описание.
@return	<- описываем возвращаемый резалт.
@todo	<- если хотите поделиться своими мыслями по поводу будущих дороботок в программе, поместите их сюда.
*/	<- закрываем коментарий для phpDOC.

В качестве примера, напишем простенький класс:

‹?
/**
 *	@author purple_m0nkey
 *	@copyright netfaq.ru
 *	@licenense GNU
*/
	class Toy {
	
		private $name;
	
		/**
			* Конструктор класса.
		  	* @param имя. ник. погоняло. кликуха. по дефолту - "Буратино".
		*/
		function Toy($name="Буратино") {
			$this->SetName($name);
		}
		/**
		  * Скажите как его зовут? Паааам, параба-рара-бам-бам :-)
		  * @return возвращает название игрушки.
		*/
		function GetName() {
			echo $this->name;
		}
		/**
		 *	Даём имя.
		 *	@param $name имя.
		*/
		function SetName($name) {
			$this->name = $name;
		}
	}
	
	$toy = new Toy("Бэтмэн");
	echo $toy->GetName();
?›

Для того что-бы создать докумментацию к нему, выполним слудующую команду: