Показать сообщение отдельно
  #8 (permalink)  
Старый 30.09.2014, 17:18
Аватар для Gozar
Отправить личное сообщение для Gozar Посмотреть профиль Найти все сообщения от Gozar
 
Регистрация: 07.06.2007
Сообщений: 7,504

Сообщение от FINoM
Нужно постоянно следить за соответствием документаций: поменялся аргумент или пример, нужно изменить доки ко всем языкам.
Это по любому придется делать, т.к. идея обязывает. Можно особо не следить, запускать парсинг по крону или другому планировщику, тот выдает уведомление. Можно даже прикрутить переводчик, но он скорее всего будет кривой.

Чем меньше промежуточных звеньев и конвертаций, тем целостней данные.

Писать доку лучше на одном языке. Почему? Потому, что парсер решит все проблемы. Если есть время и не крутить костыли, то можно накидать парсер, который сделает строение в виде дерева, а затем делать с данными все что захочешь, можно хоть в десять видов в 20 форматах выводить, с кодом, без, переводить в другие форматы и т.д.

По сути тут ничего нового. Код - это тот же текст и поддается разбору и структурированию во что угодно.

Если линковка невозможна, то можно ставить свои линки id-шники. Лучше, конечно привязываться к названию метода, app.method.get, но и id тоже возможно, но их лучше генерить. В общем самое слабое место, это линковка. Если код не структурированный, то его нужно как-то линковать, т.к. методы могут переноситься, переназываться и т.д.
__________________
Последний раз редактировалось Gozar, Сегодня в 24:14.

Последний раз редактировалось Gozar, 30.09.2014 в 17:23.
Ответить с цитированием