How to add multiple suggestions to the automatic pop-up help boxes when typing a function?

Question

Nathan 2018-12-13

0
链接

此问题的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/435631-how-to-add-multiple-suggestions-to-the-automatic-pop-up-help-boxes-when-typing-a-function

回答： Renan Thomes 2025-8-19，18:10

I have some functions that can accept variable amounts of inputs and I want to better document them by adding appropriate suggestions to the box that pops up when you begin typing the function name, like this:

Most built-in Matlab functions display help boxes like this but when I write a function from scratch, it either displays the inputs I specifically have listed, or it shows (...) if the function accepts "varargin", like so:

Those functions of course already handle the inputs properly, but I want to display the various acceptable ways of calling the function in the displayed suggestions here. Is there a way to customize this feature?

4 个评论
显示 2更早的评论隐藏 2更早的评论

Nathan 2019-7-30

在 MATLAB Online 中打开

Hi Adam,

Sorry I missed your response so long ago. Here is how the function is called:

function [ax,Gh] = plot_Earth_km(varargin)
% Plots the Earth with a textured map to scale in kilometers. 
% 
% plot_Earth_km(eq_pts) plots Earth with eq_pts number of points around the
%   equator
% 
% plot_Earth_km(eq_pts,[...]) allows several display options via name-value
%   pairs of inputs.
% 
% EXAMPLES:
% [ax,gh] = plot_Earth_km(eq_pts,'GMST',GMST);
% [ax,gh] = plot_Earth_km(eq_pts,'GMST',GMST,'Style','Night');
% [ax,gh] = plot_Earth_km(eq_pts,'JD',JD,'Style','Sunlit');

The entire function is very long, but the examples part of the help section shows some of the ways I would like suggestions to appear in the suggestion box. Obviously it currently only shows "varargin" as being an argument to the function. varargin is (are) parsed with an inputParser.

% Create parser for the inputs:
p = inputParser;
addRequired(p,'eq_pts',validPosInt)
addParameter(p,'GMST',default_GMST0,validScalar);
addParameter(p,'JD',default_JD0,validScalar);
addParameter(p,'Style','Day',validStyles);
[...]
    
% Parse the inputs:
parse(p,varargin{:})
% Extract the resulting parsed (or default) values from the given inputs:
eq_pts = p.Results.eq_pts;
GMST0 = p.Results.GMST;
JD0 = p.Results.JD;
Style = p.Results.Style;
[...]

The function does different things depending on which name-value pairs are passed. Of course if a user needs to know how to use it, they can view the help documentation, but I'd like to know how to change the suggestions if possible.

Adam Danz 2019-7-30

I know what you're talking about. I've never done this myself but here's a lead.

https://www.mathworks.com/matlabcentral/answers/338247-how-to-implement-function-hints-in-your-code#comment_625600

and

https://www.mathworks.com/help/releases/R2018b/matlab/matlab_prog/customize-code-suggestions-and-completions.html

A quicker alternative would be to make useful 'help' notes at the top of your code and cover all of the possible inputs. It looks like you're already doing that.

Nathan 2019-7-30

Ah, thank you! Unfortunately I have 2015b, so it looks like that functionality is not supported in my version. Good find though.

请先登录，再进行评论。

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

Answer 1

Renan Thomes 2025-8-19，18:10

0
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/435631-how-to-add-multiple-suggestions-to-the-automatic-pop-up-help-boxes-when-typing-a-function#answer_1569526

Starting with MATLAB R2018a, you can personalize code suggestions and completions for your functions by following the Customize Code Suggestions and Completions documentation.

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

请先登录，再进行评论。

How to add multiple suggestions to the automatic pop-up help boxes when typing a function?

4 个评论
显示 2更早的评论隐藏 2更早的评论

回答（1 个）

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

另请参阅

类别

标签

产品

Community Treasure Hunt

How to add multiple suggestions to the automatic pop-up help boxes when typing a function?

4 个评论 显示 2更早的评论隐藏 2更早的评论

回答（1 个）

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

另请参阅

类别

标签

产品

Community Treasure Hunt

4 个评论
显示 2更早的评论隐藏 2更早的评论

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