microsoft / tsdoc

A doc comment standard for TypeScript
https://tsdoc.org/
MIT License
4.74k stars 131 forks source link

Can we have rust-like three slashes for quick docs? #226

Closed alshdavid closed 4 years ago

alshdavid commented 4 years ago

For objects that need a lot of short documentation, TSDoc can be quite verbose, requiring 3 lines of code for one line of comment.

The triple slash style gives a great short-hand alternative to write notes

/// foo makes bars
function foo() {
  return 'bar'
}
Gerrit0 commented 4 years ago

160

Also, what's wrong with /** docs */?

octogonz commented 4 years ago

Closing since this is a duplicate of https://github.com/microsoft/tsdoc/issues/160