Multiline comments and prql-doc

[mattdharmon]

Could we also use multiline comments to help document functions and also use them as headers?

/**
 * Comment doc blocks to help do header documentation and 
 * function documentation like:
 *
 * @param_name <type> documentation
 */

Also would be nifty for it to generate an HTML and/or README.md file like the DBT or Elixir doc generators.

[max-sixty]

Very much agree on doc comments as good things.

I'm less persuaded by multi-line comments as separate syntax from single-line comments — is there a compelling case for them? With modern editors it's unlikely someone will have to do type 10 characters to comment out 10 lines...

I think doc comments are some way off, so I'll close this for the moment. Though if someone is keen to add them, feel free to open an issue with a proposal for how they'd be used and implemented.

Thanks for the original issue @mattdharmon

[vanillajonathan]

Related discussion #1759