Документирование заявки

Question

Лучшим является приложение, которое не нуждается в документации. Второй шаг от идеала - приложение с краткими и понятными подсказками. В то же время, всплывающие подсказки являются обязательными! Так что это отправная точка. У нас довольно большое приложение без документации. Мы медленно проводим рефакторинг, но теперь пользователю нужна документация. У нас также есть несколько технических писателей, которые могли бы документировать наше программное обеспечение, и у них есть запасные ресурсы для него. У меня есть идея, как облегчить их работу.

Пользователь перемещает мышь к элементу управления, активирует (по ярлыку) DocTool и вводит описание элемента управления. Это описание становится всплывающей подсказкой для указанного элемента управления. Так что вся эта функция является компонентом.

Q1: Кто-нибудь знает, существует ли такой компонент?

Q2: Как можно однозначно идентифицировать элемент управления для последующих ссылок? (инструментам автоматического тестирования пользовательского интерфейса как-то удается это сделать)

Answer 1

Опция 1
Вы можете проверить Глобализация WPF и применить аналогичные методы к свойству ToolTip каждого элемента управления.

Опция 2
Создание редактируемого внешнего источника данных (например, файла XML).Этот источник данных должен иметь как минимум столбцы Id и ToolTip.

Создать синглтон, который оборачивает ваш источник данных (например, ToolTipData) и предоставляет доступ к каждой строке через Id источника данных,

Определите вложенное свойство для FrameworkElement типа string с именем ToolTipId.Прикрепите его к каждому элементу управления, который нуждается во всплывающей подсказке.(Убедитесь, что к каждому элементу управления применено уникальное значение.) Значение ToolTipId должно соответствовать значению Id из источника данных.

В обратном вызове присоединенного свойства установите подсказку так, используя ToolTipId:

frameworkElement.ToolTip = ToolTipData.Default.Tooltips[ToolTipId];