Форум: Форум PHPФорум ApacheФорум Регулярные ВыраженияФорум MySQLHTML+CSS+JavaScriptФорум FlashРазное
Новые темы: 0000000
PHP 5/6. В подлиннике. Авторы: Кузнецов М.В., Симдянов И.В. Самоучитель PHP 5 / 6 (3 издание). Авторы: Кузнецов М.В., Симдянов И.В. C++. Мастер-класс в задачах и примерах. Авторы: Кузнецов М.В., Симдянов И.В. PHP на примерах (2 издание). Авторы: Кузнецов М.В., Симдянов И.В. Социальная инженерия и социальные хакеры. Авторы: Кузнецов М.В., Симдянов И.В.
ВСЕ НАШИ КНИГИ
Консультационный центр SoftTime

Форум PHP

Выбрать другой форум

 

Здравствуйте, Посетитель!

вид форума:
Линейный форум Структурный форум

тема: Документация для большого мотка слипшихся макорон
 
 автор: Holsten Bier   (14.03.2007 в 20:39)   письмо автору
 
 

Здрасте всем!
Недавно мой передо мной поставили задачу выработать некий регламент документирования кода одного большого и очень запутанного проекта. (К несчастью он практически не документирован) Проект написан с использованием возможностей ООП, которые предлагает PHP 4.3, то есть львиная доля кода - это классы. Предполагается документировать классы в соответствии с форматом phpDoc, с последующей автоматичекой генерацией HTML версии. Но вот вопрос, нужно задокументировать содержимое функций (для отдельных строк и блоков), а здесь нужно найти некий разумный подход, чтобы не затягивать это дело до бесконечности, процесс стал более менее прогнозируемым и при в конце концов получить хорошо документированный код, который удобно читать и дорабатывать.

Да, коряво я сформулировал вопрос, но все-таки, совет не дадите? Может есть уже выработанные подходы для решения подобных проблем?

   
 
 автор: cheops   (15.03.2007 в 02:16)   письмо автору
 
   для: Holsten Bier   (14.03.2007 в 20:39)
 

Какой примерно объём проекта в Мб и строках кода?

   
 
 автор: Holsten Bier   (15.03.2007 в 10:21)   письмо автору
 
   для: cheops   (15.03.2007 в 02:16)
 

Если говорить об объеме в Мб, то это около 20. По количеству строк статистики нет, можно сказать только, что их очень много...

   
 
 автор: cheops   (15.03.2007 в 13:17)   письмо автору
 
   для: Holsten Bier   (15.03.2007 в 10:21)
 

Тогда лучше описать лишь классы (кратенько перечислив методы), а также место где их искать - а всю подробную информацию оставлять в файлах и не включать в документацию или включать очень осторожно, чтобы не получить в довесок к 20 Мб ещё столько же :)))

   
 
 автор: Holsten Bier   (15.03.2007 в 14:46)   письмо автору
 
   для: cheops   (15.03.2007 в 13:17)
 

Спасибо

   
Rambler's Top100
вверх

Rambler's Top100 Яндекс.Метрика Яндекс цитирования