Please consider to support line-prefix /// as marker for ScalaDocs in similar fashion as Java supports /// from JDK 23 with JEP 467: Markdown Documentation Comments.
Such prefix has several advantages:
- it has fixed width
- formatting tools and IDEs do not try to reformat it as either
- there are no “forbidden” sequences of text, like
*/
Example of almost valid and ugly ScalaDoc:
/** start of ScalaDoc
* 2nd line aligned to first `*` on first line
* other line reformatted to alight with second `*` of first line
also valid line
ScalaDoc breaking line contains `*/` sequence
*/ // zero, one or two spaces before `*` are valid, but width is inconsistent depending on used formatting tool