Документация RotorCMS - Комментарии


Пришелец
Класс
А

Пришелец
Думаю это лишнее, не такой уж он и сложный этот движок, за вечер можно разобраться, ну если не спешить то за 2. Достаточно только посмотреть код функции.

Ну или сделать описание к классам и функциям как это принято стандартами PHPDoc. (пожелание админам smile )

Землянин
Хорошая идея.

ツ ツ ツ
Советую посмотреть в сторону phpDocumentator, правда придется самому сделать тему для него, чтоб сразу под двиг затачивало.
Плюс самому же удобней кодить будет если редактор поддерживает phpDoc, к примеру в NB наводишь на метод/функцию/класс с зажатым ctrl и тебе сразу вылазит подсказка с его описанием и за что какой параметр отвечает.
И в том же NB если ты комментировал код согласно стандартам phpDocumentator, можно одним кликом создать документацию на весь проект.

ツ ツ ツ
Вот несколько полезных ссылок а это тему
офф сай http://www.phpdoc.org/
Полезный совет http://tokarchuk.ru/2010/06/phpdocumentor-и-utf-8-исходники/
Нелохое описание возможностей http://proft.me/2008/11/25/phpdocumentor/
А

Оранжевые штаны
Документацией обычно занимаются на этапе реализации )) ну, думаю лучше поздно чем никогда. Ни в коем случае не позволяйте пользователям документировать программы
Д

Пришелец
думаю нужная вещь.с башкой согласен,не стоит юзерам документацию писать.

Пацак
третий мотор будет ?
форум с файлами и голосованием будет?
всё что угодно делается, но толъко не то, что все ждут.

Пришелец
Норм.

Пришелец
Хорошая новость)