Support tables in source code comments

[pozix604]

Please support creating tables within source code comments written with Markdown.

For example:

/// | parameter | description                   |
/// |-----------|-------------------------------|
/// | `n`       | number of players             |
/// | `start`   | starting score of each player |
/// | `k`       | scaling factor                |

[dhruvasagar]

This might be tricky, but is possible.

[pozix604]

Workaround is to uncomment, edit table, re-comment.

The use case is in programming languages that use Markdown for documentation, which is many/most languages nowadays. Particularly technical documentation tends to use many tables.

[dhruvasagar]

As of now we rely on vim settings comments, commenstring to reliably determine the expression for matching tables with comments. However, within code blocks, I don't believe this works. At least we'll have to see. If you edit the code block in a separate window with the right filetype, it should be much easier.

[Konfekt]

Thank you for bringing this up; in my case Java Docstrings seem to expect a leading asterisk, as in

* | parameter | description                   |
* |-----------|-------------------------------|
* | `n`       | number of players             |
* | `start`   | starting score of each player |
* | `k`       | scaling factor                |