Can someone explain why default PHP documentation in PHPStorm contains HTML tags?
Answered
Whenever I Ctrl+click something in PHPStorm that can open a pre-installed built-in PHP function explanation, it opens the doc with HTML littered all over the function comments explanation... which is making the difficult to read, and sometimes I just have to go to PHP.net or some other source to see it properly.
Why was it set up this way and how do I stop it or at least be able to read them properly?
Please sign in to leave a comment.
Hi there,
The main intent of such styling is to make it look better/easier to read in Documentation window (View | Quick Documentation) .. which you can invoke right in the code (even when choosing item in code completion popup) without the need to go into the function declaration (stub files in your case).
Plus, initial stubs were generated from PHP documentation (web pages I would think, not the source codes) so it can be treated as "leftovers" from that time.
>and sometimes I just have to go to PHP.net or some other source to see it properly.
In most cases with built-in functions/classes where I need detailed info I would go to PHP.net site anyway (using "View | External Documentation" shortcut to speed things up) as it has more info/examples and quite often helpful comments.
Hello,
Andriy is absolutely correct. Quick documentation renders it as HTML and tags help to quickly read it there. You can navigate to php.net right from Quick Documentation window as well or by Shift+F1 shortcut (will take you directly to the corresponding documentation page on php.net).
That's great that Quick Documentation understands HTML, but that's not what Ctrl+clicking a PHP function shows... do you think maybe it would be a good idea to have it do that, or to at least show the file without HTML?
It's a lot more steps each function to bring up Quick Documentation for it.