PhpStorm 8: Markdown Support in PHPDoc Blocks

Since PhpDocumentor allows Markdown in documentation blocks (as stated here), we have added Markdown support to PhpStorm 8 too when showing a quick documentation of classes, functions, etc. Here is a list of what is actually supported from Markdown syntax specification, with some examples:

  • Paragraphs separated by one or more line breaks. There is a continuous flow of text inside a paragraph without line breaks from the original description.
  • Headers. You can use the following style, for example:

    or use the number sign (#):
  • Emphasis. A piece of text surrounded with underscore characters (_) or asterisks (*) is rendered as underlined. You can also use double asterisks (**) to make it bold. Note that if the underscore character appears inside a name, for example my_variable, it is left as is.
  • Lists. You can use asterisks (*) or short dashes (-) at the beginning of a line to mark a list item. For example:

    These will be translated to an HTML list as follows:

    • First item
    • Second item
    • Third item
  • Code blocks. Wrap the code into backtick quotes (`) as follows:

Note: It is possible to use HTML markup in combination with Markdown.

And finally, a larger sample:

The example above will be rendered like so:

phpdoc_render_sample

If you find anything that can be improved or is not working as expected, please share your feedback in the issue tracker. Thanks!

Develop with pleasure!
-JetBrains PhpStorm Team

This entry was posted in Cool Feature, Early Access Program and tagged , , , , . Bookmark the permalink.

13 Responses to PhpStorm 8: Markdown Support in PHPDoc Blocks

  1. Yakir Sitbon says:

    How I can use with this? I do not get any autocomplate or preview in my PHPDoc from the editor.

    Thanks.

  2. MaximAL says:

    Underscores in Markdown are for italics. Aren’t they?

  3. Pingback: PhpStorm 8 - New Features

Leave a Reply

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code class="" title="" data-url=""> <del datetime=""> <em> <i> <q cite=""> <strike> <strong> <pre class="" title="" data-url=""> <span class="" title="" data-url="">