| |
|
|
| | Здрасте всем!
Недавно мой передо мной поставили задачу выработать некий регламент документирования кода одного большого и очень запутанного проекта. (К несчастью он практически не документирован) Проект написан с использованием возможностей ООП, которые предлагает PHP 4.3, то есть львиная доля кода - это классы. Предполагается документировать классы в соответствии с форматом phpDoc, с последующей автоматичекой генерацией HTML версии. Но вот вопрос, нужно задокументировать содержимое функций (для отдельных строк и блоков), а здесь нужно найти некий разумный подход, чтобы не затягивать это дело до бесконечности, процесс стал более менее прогнозируемым и при в конце концов получить хорошо документированный код, который удобно читать и дорабатывать.
Да, коряво я сформулировал вопрос, но все-таки, совет не дадите? Может есть уже выработанные подходы для решения подобных проблем? | |
| |
|
|
| |
|
|
| |
для: Holsten Bier
(14.03.2007 в 20:39)
| | | Какой примерно объём проекта в Мб и строках кода? | |
| |
|
|
| |
|
|
| |
для: cheops
(15.03.2007 в 02:16)
| | | Если говорить об объеме в Мб, то это около 20. По количеству строк статистики нет, можно сказать только, что их очень много... | |
| |
|
|
| |
|
|
| |
для: Holsten Bier
(15.03.2007 в 10:21)
| | | Тогда лучше описать лишь классы (кратенько перечислив методы), а также место где их искать - а всю подробную информацию оставлять в файлах и не включать в документацию или включать очень осторожно, чтобы не получить в довесок к 20 Мб ещё столько же :))) | |
| |
|
|
| |
|
|
| |
для: cheops
(15.03.2007 в 13:17)
| | | Спасибо | |
| |
|
|
