@internal in JavaScript / TypeScript JSDoc comments

[Bistard]

Description

When people are writing a multiline comment, we may mark it as @internal. when the classes or functions marked as internal are exported and used outside of their own files, there will render a strikethrough on the text (Just like how @deprecated works), saying this class/function is marked as internal and not supposed to be used directly in other modules.

Reason

The reason I have to export these functions or classes is that I need to write unit tests for them. They are not intended to be used directly.

When I am reading the source code of VSCode, I also realized some exported classes have comments such as DO NOT USE DIRECTLY because these are used for unit testing, which having the same reason that I have.

I think this may decrease the chances for other programmers that accidentally use them.

[Bistard]

Actually, I think using the keyword internal is not a good choice. It is already been used widely and people use them with various meanings, in this case, we can't really just define this word on our own. Maybe testonly or something similar is more practical.