Tôi đang làm việc trên mã Matlab dùng chung và chúng tôi muốn chia sẻ tài liệu được tạo dưới dạng tài liệu HTML có thể tìm kiếm trong mạng cục bộ của chúng tôi.Cách Mathworks để tạo tài liệu Matlab HTML là gì?
Tôi biết các phương pháp sau để tạo ra một tài liệu hướng dẫn:
- Viết một chuyển đổi để C++ - file như thế nào. Điều này được thực hiện trong Using Doxygen with Matlab (Cập nhật lần cuối 2011) và mtoc++ (cập nhật lần cuối 2013). Các tệp giống như C++ sau đó được phân tích bởi Doxygen.
- Sử dụng Python sphinxcontrib-matlabdomain để tạo tài liệu HTML.
- Sử dụng m2html cũng là giải pháp của bên thứ ba.
- Các tùy chọn khác được liệt kê trong Q & Là: One, Two và Three.
Tất cả các khả năng không được Mathworks hỗ trợ. Tất cả các khả năng cần tôi đề cập đến tức là các thông số của một hàm tôi. Họ không phân tích mã theo nghĩa, Doxygen hiện nó cho ví dụ: Java:
//! an object representation of the advertisement package sent by the beacon
private AdvertisementPackage advertisementPackage;
Tôi nghe nói về publish() chức năng của Matlab, nhưng tôi đã không bao giờ nhìn thấy nó được sử dụng theo nghĩa nói trên.
Câu hỏi: Cách Mathworks để tạo tài liệu Matlab HTML là gì. Bản thân mã có thể được phân tích không? Tôi có thể sử dụng thông tin được cung cấp cho Trình phân tích cú pháp đầu vào Matlab không? Vui lòng đề cập đến sở thích cá nhân của bạn trong các nhận xét.
Ví dụ:
%% 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);
Để làm rõ [tiện ích mở rộng Sphinx matlabdomain] (https://pypi.python.org/pypi/sphinxcontrib-matlabdomain), tác giả của tôi, _does_ phân tích mã của bạn và tự động tạo tài liệu tương tự như Epydoc. Hãy thử sử dụng ['autosummary extension'] (http://sphinx-doc.org/latest/ext/autosummary.html) để liệt kê nguồn mong muốn của bạn, sau đó sử dụng [' sphinx-autogen'] (http: // sphinx- doc.org/latest/ext/autosummary.html?highlight=autogen) để tự động tạo ['autodoc'] (http://sphinx-doc.org/latest/ext/autodoc.html#module-sphinx.ext.autodoc) các tệp sơ khai, sau đó tạo tài liệu của bạn. –
Bây giờ chúng tôi quyết định đi theo con đường Nhân sư khi chúng tôi nhận được phản hồi nhanh và tốt khi gặp sự cố. – Lukas