Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explicitly flag protected class attributes #3

Open
antoinetissier opened this issue Jan 29, 2021 · 0 comments
Open

Explicitly flag protected class attributes #3

antoinetissier opened this issue Jan 29, 2021 · 0 comments

Comments

@antoinetissier
Copy link
Collaborator

For classes, there is no difference made between protected and public attributes in the generated doc.

As far as I know, protected in JavaScript is more of a convention than a real enforcement. The language won't prevent you from doing myClassInstance.myProtectedAttribute. So if it's not explicit in the doc, people might introduce bad patterns in their code without even knowing it.

For this reason, I think it would be nice if the generated doc could explicitly flag protected class attributes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant