Я работаю над общим кодом Matlab, и мы хотели бы предоставить сгенерированную документацию в виде документов HTML с возможностью поиска в нашей локальной сети.
Я знаю следующие методы для создания документации:
- Запишите конвертер в файлы на С++. Это делается в Использование Doxygen с Matlab (Последнее обновление 2011) и mtoc++ (последнее обновление - 2013). Затем файлы, похожие на С++, обрабатываются Doxygen.
- Используйте Python sphinxcontrib-matlabdomain для создания документации HTML.
- Используйте m2html, который также является сторонним решением.
- Дополнительные параметры перечислены в этом Q & As: Один, Два и Три.
Все возможности не поддерживаются Mathworks. Все возможности требуют, чтобы я упоминал, например, параметры функции. Они не анализируют код в том смысле, Doxygen делает это, например, для Java:
//! an object representation of the advertisement package sent by the beacon
private AdvertisementPackage advertisementPackage;
Я слышал о функции Matlab publish(), но я никогда не видел, чтобы она использовалась в вышеупомянутом смысле.
Вопрос: Каков способ Mathworks для создания документации HTML Matlab. Можно ли проанализировать сам код? Могу ли я использовать информацию, предоставленную в Matlab Input Parser уже? Пожалуйста, укажите ваши личные предпочтения в комментариях.
Пример:
%% Input parser
p = inputParser;
addRequired(p, 'x', @isnumeric);
validationFcn = @(x) (isnumeric(x) && isscalar(x));
addRequired(p, 'fftSize', validationFcn);
addRequired(p, 'fftShift', validationFcn);
validationFcn = @(x) (isa(x, 'function_handle'));
addRequired(p, 'analysisWindowHandle', validationFcn);
parse(p, x, fftSize, fftShift, analysisWindowHandle);
