LearnNewsExamplesServices
Frontmatter
id721
titledoc comments: private VS protected
stateClosed
labels
enhancementhelp wantedgood first issue
assignees[]
createdAtJun 14, 2020, 5:34 PM
updatedAtJun 21, 2020, 5:03 PM
githubUrlhttps://github.com/neomjs/neo/issues/721
authortobiu
commentsCount1
parentIssuenull
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtJun 21, 2020, 5:03 PM

doc comments: private VS protected

Closed v1.2.12/archive-v1-2-12-chunk-1 enhancementhelp wantedgood first issue
tobiu
tobiu commented on Jun 14, 2020, 5:34 PM

so far i have sticked to "private" for pretty much everything which should not get used.

it would be more clear and correct to replace a big part of them with "protected".

sticking to the definition:

  1. private: only used inside the same class
  2. protected: only used inside the same class as well as classes extending this one

e.g. afterSetX methods are obviously meant to get overridden with super class calls.

since there are 100s of items, help on this one would be appreciated.

tobiu added the enhancement label on Jun 14, 2020, 5:34 PM
tobiu added the help wanted label on Jun 14, 2020, 5:34 PM
tobiu added the good first issue label on Jun 14, 2020, 5:34 PM
tobiu
tobiu Jun 15, 2020, 8:59 AM

it actually might be a good start to just replace all occurrences of @private with @protected.

tobiu referenced in commit 9b94c7a - "doc comments: private VS protected #721" on Jun 20, 2020, 7:18 PM
tobiu referenced in commit 4168d21 - "#721 adjusted the docs app to display protected members" on Jun 20, 2020, 7:26 PM
tobiu closed this issue on Jun 21, 2020, 5:03 PM