Просмотр полной версии : Структура справки.
Хочу узнать мнение какой стуктурой удобнее пользоваться, разделенной или общий.
Например в хелпе для AS2, каждый метод и свойство описываются в собственной статье.
А для AS3 одна статья на весь класс.
Отдельно на каждый метод удобней, вываленная справка по всему классу - ужас (ИМХО) - палец скролить отвалится.
В справке по AS3 плохо видны границы, где кончается описание одного метода/свойства и начинается описание другого. При беглом просмотре это не удобно, потому что дизориентирует.
В справке по AS2 для каждого метода/свойства были примеры, так как они описывались в собственной статье. В справке по AS3 один пример на класс - это не удобно.
2 7thsky™:
Скролл колесом можно ликвидировать переходам по якорям. Но для этого нужно меню в AS3 сделать как в AS2, то есть деревом
2MrPoma:
Вопрос о примерах несколько из другой области. Могли и для каждого свойства/метода свой пример сделать. Но не суть.
А вот, что все идет одним списком и легко потеряться, меня тоже смущает. Вот и хочу узнать, кому удобен общий список и почему.
vitlance
12.05.2008, 20:53
Общий список - полный маразм.. Всё время теряюсь, уже 3-ий месяц пытаюсь привыкнуть...
У общего списка есть и определенное достоинство... в виду того, что сайт Адоби часто плющит и ждать открытие каждой страницы становиться неимоверно долго - братская могилка лучше =) А если речь о встроенной справке, то, конечно, лучше на каждый метод.
И вообще, есть смысл, ИМХО в пол тему переделать =)
PS. Зы, по новой справке ориентируюсь через Контрл Ф. И колесико крутить не надо =)
И вообще, есть смысл, ИМХО в пол тему переделать =)Чего?
кстати да, есть такой прикол у CS3, тормозит сильно окошко с хелпом, и чем больше в нем загружена страница, тем больше тормозит, так что вариант как для as2 я считаю более подходящим.
Меня больше интересует само удобство пользования, а не привязка к конретному случая. На месте хелпа AS2/AS3 может быть что угодно. Поэтому будем считать, что все летает.
Для общей страницы, я вижу только одно оправдание. Это когда вы решили прочитать весь хелп от и до, тогда постоянно тыкать по статьям надоедает.
Fernando Costa
12.05.2008, 23:43
ужас как не удобно стало, думал привыкну - фиг
Бармалей
13.05.2008, 00:30
Новая справка хороша тем, что позволяет на одной странице отображать (и скрывать) ВЕСЬ список членов класса: как объявленных в самом классе, так и унаследованных от суперклассов. Причем тут же видно, от какого суперкласса что унаследовалось. Старый "разделенный" способ отображения справки не целесообразен уже из-за того, что привел бы к дублированию статей по одним и тем же свойствам и методам унаследованным от надклассов.
Бармалей, это далеко не так. В справке по AS2 в общей статье, где перечисляются все методы и свойства, есть также и наследуемые: "Methods inherited from class Object" и никакого дублирования, идет переход сразу к статьям надкласса.
Чего?
пол = опрос %)
чет я не подумал %)
новая справка полностью удобна. чёткая иерархия, лишними методами-свойствами сразу не грузит, но они легко доступны одним кликом. весь набор свойств-методов и примеры перед глазами, анкеры спасают конечно
чёткая иерархияВ чем она проявляется?
лишними методами-свойствами сразу не грузит, но они легко доступны одним кликом.
Что есть лишние методы? Если я хочу прочитать только про метод draw, то все остальные будет для меня лишними. Но при этом перед глазами, вернее слева, будет дерево с другими методами.
Нужны ли все методы в одном флаконе с полным описанием? См. выше. Если одних названий мало, можно перейти на страницу с кратким описанием всех методов и свойств. Например. (http://livedocs.adobe.com/flash/8/main/wwhelp/wwhimpl/common/html/wwhelp.htm?context=LiveDocs_Parts&file=00001942.html)
весь набор свойств-методов и примеры перед глазамиСм. выше. Примеры в старой версии были тоже перед глазами.
Psycho Tiger
13.05.2008, 13:58
Help Flash 8 уделывает Help CS`а без б :D
terbooter
13.05.2008, 15:59
Справка как в ас2 удобнее.
Справка как в ас3 "с элементом неожиданности"
пошел читать про один метод, а обнаружил еще полезную фичу (когда здоровенная статья перескочила случайно куда-то).
Но очень не удобно искать нужный пример приходиться пролистывать все (в статье про клас может быть 3-4 примера разбросаных по всей статье, а не один, как считает MrPoma. Может он остальные ненаходит -))
Бармалей
14.05.2008, 03:16
В доках по АС2 есть общий практически для всех классов блок, где описываются члены, унаследованные от Object. Но в АС3 более сложная иерархия объектов. Потребовалось бы несколько таких блоков. Пример для класса mx.containers.VBox: "Methods inherited from class Object", "Methods inherited from class EventDispatcher", "Methods inherited from class DisplayObject", "Methods inherited from class InteractiveObject", "Methods inherited from class DisplayObjectContainer", "Methods inherited from class Sprite", "Methods inherited from class FlexSprite", "Methods inherited from class UIComponent", "Methods inherited from class Container", "Methods inherited from class Box". Примерно такое же количество блоков понадобилось бы для описания унаследованных свойств.
Честно говоря я считаю текущее состояние справки является необходимостью при попытке описания более сложной версии языка, чем была предыдущая. Мне кажется Адоби с этим справились. Хотя примеров использования конкретных методов и свойств хотелось бы побольше.
В доках по АС2 есть общий практически для всех классов блок, где описываются члены, унаследованные от Object. Но в АС3 более сложная иерархия объектов. Потребовалось бы несколько таких блоков.Безобразие! Конечно нельзя сделать в старой версии справки таблицу и перенести туда описанием методов наследуемых свойств и методов. Это же богохульство! Надо обязательно для этого новую версия справки сделать.
Речь об идеи подачи справки: общий список или статья, а не об отдельных элементах. Добавили они тут кнопочку скрыть или не добавили. И для AS3 вполне подошла структура AS2. Сводная таблица методов/свойств + разворачиваемые таблицы наследуемых методов/свойств. Но на каждую отдельная статья.
А уж про меню я вообще молчу. Можно было сделать хождение как по алфавиту, так и по дереву наследования.
ФЗ, я справкой по АС3 пользуюсь примерно так:
вариант 1. (если я помню, как называется класс и метод/свойство):
Название класса -> в буфер
страница "все классы" -> Контрл + Ф
Некст, некст, пока не попадаю на нужную ссылку.
Аналогично повторяю с методом.
вариант 2. (не помню точно название метода/свойства):
Открываю страницу с описанием класса и скролл + читать чего про методы/свойства написано...
В любом случае мне нужно сначала попасть на общую таблицу, а потом идти читать про конкретный метод, так что думаю, что дерево тут было бы уместнее, чем список.
Работает на vBulletin ® версия 3.7.3. Copyright ©2000-2026, Jelsoft Enterprises Ltd. Перевод: zCarot
Copyright © 1999-2008 Flasher.ru. All rights reserved.