Xwab
Форумыnavigate_nextПрограммирование на PHP

Документация
Понятен ли выбранный формат документирования
Все понятно, дальше в том же духе: 0%
Все понятно, но слишком сложно написано: 33%
Не все понятно, не хватает информации: 33%
Не все понятно, слишком сложно написано: 33%
Опрошено: 3
Сообщения
Башка

Не знал в каком п/ф писать, потому не серчайте.

Доброго времени суток.
Начал документировать свою систему, но хотел бы спросить, достаточно ли понятен выбранный мной формат документирования? Я прикреплю файл с документацией одного класса и прошу вас оценить, насколько вы поняли его прочитав документацию. Что в ней лишнее (и почему), а что стоило бы добавить (и почему).
Заранее благодарен
добавлено спустя 2 минуты:
Для ленивых - онлайн читалка http://www.viewdocsonline.com/document/awmzk6

27 Мар 2013, 23:05
Flyd

Что делает класс понятно, пример понятен, пять уровней вложенности namespace наверное не пойму никогда

27 Мар 2013, 23:21
Башка

Это как папки в файловой системе, проще найти класс, если он лежит в определенном месте в папке

27 Мар 2013, 23:40
Okula

Башка, лучше используй формат PHPDoc. Так будет понятнее и во всех IDE отображаться будет.

28 Мар 2013, 7:17
Башка

Я его использую тоже, но в исходниках. Проблемно заставить новичков читать исходники, проще начать с другого формата

28 Мар 2013, 7:37
Верный

Башка, скинь наконец хоть модуль форума, а то о дельфиниум никто толком и не знает...

28 Мар 2013, 19:19
Башка

Я же показывал рабочий пример:
http://dagparus.ru

28 Мар 2013, 20:07
Flyd

Башка, как-то сильно тупит сайт

28 Мар 2013, 20:11
Башка

Там части экранов еще нету. Работают следующие пункты меню: главная, новости, контакты, Microsoft. Теребили меня запускать сайт, а контент не подготовили. Он кстати веб, так что смотреть через кумп, но люди говорят, что с андройда работает тоже

28 Мар 2013, 20:18
Flyd

Полоску вверху или закрепили бы или оставили бы вверху. А так бегает за тобой при скролле, только мешает

28 Мар 2013, 20:23
Ответить на тему