Перейти к содержанию
babushka

Нужна помощь в документировании кода движка

Рекомендуемые сообщения

Всем доброго дня.

На форуме в свое время была поднята хорошая идея создать комментарии ко всем функциям и классам движка. Мне идея понравилась и я хочу попросить вас помочь с этим. Разумеется минимальные знания php и движка нужны.

Что это даст?

После коментирования кода его можно будет прогнать через phpDocumentator( http://phpdoc.org ) и получить хорошую доку.

Это сильно облегчит и ускорит процесс разработки в дальнейшем. И под рукой всегда будет описание всех классов и функций движка.

Все это будет добавлено в основной репозиторий и доступно всем без ограничений. Саму доку выложу на сайте для свободного доступа.

--

Все кто готов помочь, отпишитесь в этой теме. Так же, если есть кто уже делал такие вещи прошу поделиться опытом. Как лучше организовать процесс и взаимодействие.

Заранее всем спасибо за участие.

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

помогу, если скажут что нужно описать)

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

помогу, если скажут что нужно описать)

Все очень просто :) Весь код OpenCart по стандартам phpDoc. С SVN работал?

Поделиться сообщением


Ссылка на сообщение
Поделиться на другие сайты

Для публикации сообщений создайте учётную запись или авторизуйтесь

Вы должны быть пользователем, чтобы оставить комментарий

Создать учетную запись

Зарегистрируйте новую учётную запись в нашем сообществе. Это очень просто!

Регистрация нового пользователя

Войти

Уже есть аккаунт? Войти в систему.

Войти

  • Последние посетители   0 пользователей онлайн

    Ни одного зарегистрированного пользователя не просматривает данную страницу

×

Важная информация

На нашем сайте используются файлы cookie и происходит обработка некоторых персональных данных пользователей, чтобы улучшить пользовательский интерфейс. Чтобы узнать для чего и какие персональные данные мы обрабатываем перейдите по ссылке. Если Вы нажмете «Я даю согласие», это означает, что Вы понимаете и принимаете все условия, указанные в этом Уведомлении о Конфиденциальности.