MATLAB не показывает помощь для созданного пользователя класса частных методов и свойств

Question

Это проблема:

1. Создать класс и установить доступ быть частными для некоторых свойств или методов.

2. Используйте команду doc для созданного класса. Это позволит автоматически генерировать документацию из ваших комментариев и показывать ее во встроенном браузере справки.

   doc classname

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

Answer 1

Так что я потратил 10 минут, используя отладчик, перепрыгнув с одной функции на другую, отслеживая путь выполнения простого вызова doc MyClass.

В конечном счете это привело меня к следующему файлу:

fullfile(toolboxdir('matlab'),'helptools','+helpUtils','isAccessible.m') 

Эта функция вызывается в процессе генерации документации для класса, чтобы определить, если элементы класса (включая методы, свойства и события) публично доступный и не скрытый. Эта информация используется позже, чтобы «отбросить» элементы.

Так что, если вы готовы изменить внутренние функции MatLab, и вы хотите, чтобы документы всегда показывают все методы и свойства, независимо от их объема, просто переписать функцию, чтобы сказать:

function b = isAccessible(classElement, elementKeyword) 
    b = true; 
    return 

    % ... some more code we'll never reach! 
end 

Конечно, дон «забудьте сделать резервную копию файла в случае, если вы передумали позже :)

(на недавнем Windows, вам нужно выполнить этот шаг с правами администратора)

---

В качестве теста возьмите класс образца, определенный в this page, и запустите doc someClass.Результат:

Answer 2

Это поведение по дизайну - автоматически созданная документация предназначена для пользователей этого класса, которые могли бы получить доступ к общедоступным свойствам и методам.

Я не знаю, как это изменить.

Вы можете попробовать:

1. Используйте альтернативную систему автоматической генерации документации, такой как this из MATLAB Central File обменника (который я считаю, будет документировать все свойства, а не только общественности).
2. Внесите свою команду doc. Ваша команда doc должна принимать те же самые входы, что и встроенная команда doc, определить, соответствуют ли ее входы вашему классу/методам/свойствам и т. Д., И если они отображают их документацию, в противном случае передайте свои входы прямо к встроенному doc , Убедитесь, что ваша команда впереди встроенного в путь.