Open Tille88 opened 6 years ago
Alternatively having a documentaiton tool taking away the need for quite a few comments, such as return values information? JSdocs doesn't seem to be heavily used for angular, this one seems to be the most used one https://compodoc.github.io/compodoc/
Still would probably not remove all the need for commenting guidance given the amount of people who are likely to move in and out of this project over time.
For the style guide, it would be nice to see or point developers to what is considered a good or bad comments?
The codebase is not very comment heavy, but some examples of when a variable/function name is declarative enough that adding comments could do more harm than good could be useful when trying to add to the codebase without having to just sample a small part of the code and then hope it is representative.