Change documentation color for help

2 次查看（过去 30 天）
Kambren Rowlan
Kambren Rowlan 2017-8-4
编辑： Baptiste Ottino 2017-8-8
I'd like to change the color that some of the documentation that is displayed when entering the command
help myfunction
function myfunc = afunction()
%my documentation
%DOCUMENTATION THAT I WOULD LIKE RED
functionstuff
end
Any way to do this?

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

采纳的回答

Walter Roberson
Walter Roberson 2017-8-4
No, there is no way to do that, not using help.
If you were using Live Scripts then you could embed Latex formatted comments and those could potentially have color information in them.
https://www.mathworks.com/help/matlab/matlab_prog/insert-equations.html

更多回答（1 个）

Baptiste Ottino
Baptiste Ottino 2017-8-8
编辑：Baptiste Ottino 2017-8-8
It is not possible to do something like this for:
help afunction
However, it is perfectly possible to do this for the ouput of
doc afunction
which is more elegant, but it is a bit tricky. Here is how.
The idea is to directly use html tags inside your documentation. For this you have to open the help2html function
edit help2html
and between lines 69 and 70 add
helpstr = regexprep(helpstr,'&lt;','<');
helpstr = regexprep(helpstr,'&gt;','>');
Which will ensure that html tags can be used in your help. Then, use the span tag to define the color:
function myfunc = afunction()
%my documentation
%<span style="color:red">DOCUMENTATION THAT I WOULD LIKE RED</span>
functionstuff
end
For the following result:
Hope this helps.
EDIT:
I thought of a better solution. First, you can copy the help2html file and its 'private' directory above in the Matlab path to overload it, which is safer, second, instead of adding the lines I suggested, just comment line 25
% helpstr = fixsymbols(helpstr);
  2 个评论
Walter Roberson
Walter Roberson 2017-8-8
(I touched up your code so that it shows up correctly. It is an oddity of the system that HTML named entities are translated into the designated entity even in code blocks, so when you wrote &lt; in your code, that gets translated to < . To get it to show up right you have to replace the & with &amp;
Baptiste Ottino
Baptiste Ottino 2017-8-8
Thank you very much, it is good to know.

请先登录，再进行评论。

类别

在 Help Center 和 File Exchange 中查找有关 Environment and Settings 的更多信息

标签

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!

Translated by