我正在开发共享的 Matlab 代码,我们希望在本地网络中将生成的文档作为可搜索的 HTML 文档共享。
我知道以下生成文档的方法:
- 编写一个类似于 C++ 文件的转换器。这是在中完成的将 Doxygen 与 Matlab 结合使用 http://www.mathworks.com/matlabcentral/fileexchange/25925-using-doxygen-with-matlab(最后更新于 2011 年)和mtoc++ http://www.mathworks.com/matlabcentral/fileexchange/33826-mtoc++-doxygen-filter-for-matlab-and-tools(最后更新于 2013 年)。然后,Doxygen 会解析类似 C++ 的文件。
- 使用Python的sphinxcontrib-matlab域 https://pypi.python.org/pypi/sphinxcontrib-matlabdomain生成 HTML 文档。
- Use m2html http://www.artefact.tk/software/matlab/m2html/这也是第三方解决方案。
- 此问答中列出了更多选项:One https://stackoverflow.com/questions/4912829/matlab-documentation-function?rq=1, Two https://stackoverflow.com/questions/7840964/how-can-one-generate-good-documentation-for-object-oriented-matlab-code and Three https://stackoverflow.com/questions/14986704/export-auto-generate-matlab-doc-to-html?rq=1.
Mathworks 并不支持所有可能性。所有可能性都需要我自己提及,即函数的参数。他们不会从某种意义上分析代码,Doxygen 会为 Java 进行分析:
//! an object representation of the advertisement package sent by the beacon
private AdvertisementPackage advertisementPackage;
我听说过Matlab发布() http://www.mathworks.de/de/help/matlab/matlab_prog/publishing-matlab-code.html函数,但我从未见过它在上述意义上使用过。
问题:Mathworks 生成 Matlab HTML 文档的方式是什么。代码本身可以分析吗?我可以使用提供给 Matlab 输入解析器的信息吗?请在评论中提及您的个人偏好。
Example:
%% 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);