Can Matlab compiler pass the summary of functions?

2 次查看（过去 30 天）

Yoshihiro Yamada 2018-1-23

0
链接

此问题的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/378474-can-matlab-compiler-pass-the-summary-of-functions

评论： Yoshihiro Yamada 2018-1-26

When I build .Net assemly from C# source codes, the summary of functions, which is represented by xml comments, can be seen via "Objet Browser" in Visual Studio.

Is it possible to see the summary of Matlab functions, which is compiled by mcc command, in "Objet Browser", like C#?

If possible, please let me know how to realize.

0 个评论
显示 -2更早的评论隐藏 -2更早的评论

请先登录，再进行评论。

请先登录，再回答此问题。

采纳的回答

Kojiro Saito 2018-1-25

2
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/378474-can-matlab-compiler-pass-the-summary-of-functions#answer_301702

This way is not documented, but there's a way to create function summaries to your dll.

Go to Apps -> Library Compiler and select .NET assembly and package functions, MATLAB Compiler SDK will create document XML files in for_testing folder. In this example, MagicSquareComp.xml will be created in for_testing folder. This XML file contains summary tags. Copy this XML file to your dll (For example, MagicSquareComp.dll) which was added to reference in your Visual Studio solution file. After that, you will find summary information is added in Object Browser.

You can edit the XML file so as to change the descriptions. You might need to restart Visual Studio to refresh the display of Object Browser.

Hope this help.

5 个评论
显示 3更早的评论隐藏 3更早的评论

Kojiro Saito 2018-1-26

I think comments in the original MATLAB function will be converted to &ltremarks&gt tag in XML. But &ltparam&gt and &ltreturns&gt tags will be created if the MATLAB function has input arguments and output. So, you can edit the XML file manually.

Yoshihiro Yamada 2018-1-26