2010-02-03 5 views
4

Является ли это моим браузером, который не работает с their API online documentation?Почему документация API Zend Framework плохой?

Структура, кажется, очень плохая по сравнению с Java API online documentation и Yii API online documentation.

Я новичок в Zend Framework, поэтому я задаюсь вопросом, должно ли это быть так?

+0

Да, висит каждый из моих браузеров. Я предполагаю, что некоторые легкие javascript. Заставляет меня задуматься о качестве кода PHP, управляющего инфраструктурой. –

+0

Я голосую, чтобы закрыть этот вопрос как не по теме, потому что это не относится к задаче, связанной с программированием. Вопросы или проблемы качества документации должны быть направлены на авторов/сопровождающих этой документации. – bta

ответ

5

Я думаю, что API хорошо, единственная проблема, иногда они не дают реального значения аргументов

После того, как API, может быть, немного позади некоторых примеров Java, но я нахожу reference guilde тихий впечатляющий и полный. У вас есть 900 страниц, описывающих каждую часть фреймворка с кратким фрагментом кода, который просто замечательный.

Лично я чаще использую справочное руководство, а затем документацию по API.

+2

Документы API генерируются из блоков PHPDoc ... и если бы там были примеры кода и что-то там, то ZF будет напоминать массу текста 200 МБ. Все важные вещи приведены в справочном руководстве. Вы можете проверить документы API только для недокументированных «новых» функций ... –

+0

Справочное руководство с ошибками, такими как Быстрый старт. Тогда мне нужно что-то делать, я должен использовать отслеживание кода :( – Liutas

3

Я уже в течение месяца работаю в Zend Framework. Я начинаю ловить, но я должен согласиться с первоначальным комментарием. Документация API, по крайней мере, то, что доступно, является жестокой. Что это за материал Dojo? Я ожидал бы правильную стандартизованную ссылку API для чего-то столь же обширного и мощного, как Zend Framework. Для опытного инженера-программиста справочное руководство - действительно вводный материал. После того, как он переваривается, все, что действительно необходимо, - это хорошая ссылка API, в которой четко указаны свойства, методы, дерево наследования с краткими описаниями, где это необходимо. Как Java, AS3 и т. Д. Я мог бы сэкономить около двух недель, если бы у меня был полный доступ к API. Я не понимаю, но я намерен упорствовать с ZF.

1

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

Я считаю, что его следует переоценить, чтобы быть похожим на документацию, где каждая страница предназначена для выполнения определенной задачи, например «Сохранение данных», «Удаление данных», «Проверка данных» и т. Д.

Примеры реальной жизни с контекстом являются гораздо более полезными, чем Zend Docs, где я склонен угадывать, откуда происходят определенные переменные (обычно $db) - и в полном объеме случаи MVC.

Смежные вопросы