Support a comment style that only uses line comments with three slashes

[marijnh]

Search Terms

commentStyle triple-slash

Problem

I find using line comments for doc comments a great experience (less wasted lines, easier to format), which has been supported in TypeDoc since #1433 . But in my projects I use the additional convention that only lines starting with three slashes are doc comments, to explicitly mark them as doc comments and to avoid regular comments accidentally ending up in my docs. I'm looking to move from getdocs-ts to TypeDoc, and would love for this tool to support my workflow.

Suggested Solution

It appears to be very simple to add this feature.

I'm not entirely sure about the name the comment style should have. I went with "line-triple" but can imagine "lineTriple" or just "triple" fitting the project conventions better.

If this addition would be acceptable, let me know what name to use, and I'll submit a PR.

[Gerrit0]

I think the best name is probably triple-slash - someone coming from a language like C# where it is common will be more likely to search for that than line-triple. Looking forward to the PR!

[marijnh]

Done: #3090