Документирование атрибутов объектов Core Data с помощью записей информации о пользователе
Мы ищем способ документировать объекты Core Data. Пока что я придумал только следующие варианты:
- Документировать извне, используя UML или какой-либо другой стандарт
- Создавать подклассы NSManagedObject для каждой сущности и использовать комментарии к коду
- Использовать словарь User Info для создания ключа пара значений, которая содержит строковый комментарий
Вариант 1 кажется слишком большим объемом дополнительной работы и чем-то, что почти наверняка будет устаревшим в 99% случаев.
Вариант 2 кажется естественным и более правильным, чем вариант 1. Самый большой недостаток здесь заключается в том, что эти комментарии потенциально могут быть потеряны, если этот класс модели будет перегенерирован с использованием Xcode.
Вариант 3 кажется немного менее правильным, чем вариант 2, но имеет дополнительное преимущество, заключающееся в добавлении возможностей автоматизации в отношении извлечения метаданных. Например, в одном из наших приложений нам нужно очень внимательно следить за тем, что мы храним локально на устройстве, а также за синхронизацией с iCloud.Используя информационный словарь пользователя, довольно легко автоматизировать создание некоторой формы артефакта, который может быть проверен как внутри, так и снаружи (клиентом) на соответствие
. Поэтому мой вопрос заключается в том, будет ли неуместно использовать словарь пользовательской информации. для этой цели? И есть ли какие-либо другие параметры, которые я упускаю?